OpenSimulator - User contributions [en]

RestConsole

2026-03-16T07:34:59Z

Ferd Frederix: /* C# = */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

Some of the examples below are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (tx0h) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

== C# ==

<source lang = "Csharp">

// XmlDocument and XmlNode require using System.Xml; at the top of your file if not already present.

private bool RestConsoleCommand(string command, string ip, string port)
{
string consoleLogin = $"http://{ip}:{port}/StartSession/";

var diction = new Dictionary<string, string>
{
{ "USER", $"{AdminFirst} {AdminLast}" },
{ "PASS", Settings.ConsolePassword }
};

string xmlResponse = HttpHelper.PostForm(consoleLogin, diction, 2000);
var parser = new XmlDocument();

try
{
parser.LoadXml(xmlResponse);
XmlNode sessionNode = parser.SelectSingleNode("ConsoleSession/SessionID");

if (sessionNode == null)
return false;

string sessionID = sessionNode.InnerText;

string consoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/SessionCommand/";
diction = new Dictionary<string, string>
{
{ "ID", sessionID },
{ "COMMAND", command }
};

string result = PostForm(consoleCommandUrl, diction, 2000);
parser.LoadXml(result);
sessionNode = parser.SelectSingleNode("ConsoleSession/Result");

if (sessionNode == null)
return false;

string r = sessionNode.InnerText;
CloseSession(sessionID);
return r == "OK";
}
catch (Exception ex)
{
ErrorLog(ex.Message);
}

return false;
}

private void CloseSession(string sessionId)
{
string consoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/CloseSession/";
var diction = new Dictionary<string, string>
{
{ "ID", sessionId }
};

PostForm(consoleCommandUrl, diction, 2000);
}

public string PostForm(string url, Dictionary<string, string> formData, int timeoutMilliseconds)
{
using (var client = new HttpClient())
{
client.Timeout = TimeSpan.FromMilliseconds(timeoutMilliseconds);

var content = new FormUrlEncodedContent(formData);
var response = client.PostAsync(url, content).GetAwaiter().GetResult();

response.EnsureSuccessStatusCode();

return response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
}
}
</source>

== Visual Basic Dot Net 8 ==

<source lang = "vb">

' Visual Basic Dot Net 8
Private Function RestConsoleCommand(command, IP as String, Port as String) As Boolean '
Dim ConsoleLogin = $"http://{IP}:{Port}/StartSession/"

Dim Diction = New Dictionary(Of String, String) From {
{"USER", $"{AdminFirst} {AdminLast}"},
{"PASS", Settings.ConsolePassword}
}

Dim xmlresponse = HttpHelper.PostForm(ConsoleLogin, Diction, 2000) 'Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>
Dim parser = New XmlDocument()
Try
parser.LoadXml(xmlresponse)
Dim sessionNode = parser.SelectSingleNode("ConsoleSession/SessionID")
If sessionNode Is Nothing Then
Return False
End If
Dim sessionID = sessionNode.InnerText

'POST http://foo.bar:8002/SessionCommand/
'Parameters: sessionID, COMMAND

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/SessionCommand/"
Diction = New Dictionary(Of String, String) From {
{"ID", sessionID},
{"COMMAND", command}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
parser.LoadXml(result)
sessionNode = parser.SelectSingleNode("ConsoleSession/Result")
If sessionNode Is Nothing Then
Return False
End If
Dim r = sessionNode.InnerText
If r = "OK" Then
CloseSession(sessionID)
Return True
Else
CloseSession(sessionID)
Return False
End If

Catch ex As Exception
ErrorLog(ex.Message)
End Try
Return False

End Function
Private Function CloseSession(SessionId As String)

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/CloseSession/"
Dim Diction = New Dictionary(Of String, String) From {
{"ID", SessionId}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
End Function

Public Function PostForm(url As String, formData As Dictionary(Of String, String), timeoutMilliseconds As Integer) As String
Using client As New HttpClient()
client.Timeout = TimeSpan.FromMilliseconds(timeoutMilliseconds)

Dim content = New FormUrlEncodedContent(formData)

Dim responseTask = client.PostAsync(url, content)

'Block the current thread until the task Is complete And get the result
Dim response = responseTask.GetAwaiter().GetResult()

response.EnsureSuccessStatusCode() ' Throws an exception If the status code Is an Error

Dim responseBodyTask = response.Content.ReadAsStringAsync()

' Block to get the response body string
Return responseBodyTask.GetAwaiter().GetResult()
End Using
End Function

</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

RestConsole

2026-03-16T07:34:37Z

Ferd Frederix: /* csharp */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

Some of the examples below are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (tx0h) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

== C# ===

<source lang = "Csharp">

// XmlDocument and XmlNode require using System.Xml; at the top of your file if not already present.

private bool RestConsoleCommand(string command, string ip, string port)
{
string consoleLogin = $"http://{ip}:{port}/StartSession/";

var diction = new Dictionary<string, string>
{
{ "USER", $"{AdminFirst} {AdminLast}" },
{ "PASS", Settings.ConsolePassword }
};

string xmlResponse = HttpHelper.PostForm(consoleLogin, diction, 2000);
var parser = new XmlDocument();

try
{
parser.LoadXml(xmlResponse);
XmlNode sessionNode = parser.SelectSingleNode("ConsoleSession/SessionID");

if (sessionNode == null)
return false;

string sessionID = sessionNode.InnerText;

string consoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/SessionCommand/";
diction = new Dictionary<string, string>
{
{ "ID", sessionID },
{ "COMMAND", command }
};

string result = PostForm(consoleCommandUrl, diction, 2000);
parser.LoadXml(result);
sessionNode = parser.SelectSingleNode("ConsoleSession/Result");

if (sessionNode == null)
return false;

string r = sessionNode.InnerText;
CloseSession(sessionID);
return r == "OK";
}
catch (Exception ex)
{
ErrorLog(ex.Message);
}

return false;
}

private void CloseSession(string sessionId)
{
string consoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/CloseSession/";
var diction = new Dictionary<string, string>
{
{ "ID", sessionId }
};

PostForm(consoleCommandUrl, diction, 2000);
}

public string PostForm(string url, Dictionary<string, string> formData, int timeoutMilliseconds)
{
using (var client = new HttpClient())
{
client.Timeout = TimeSpan.FromMilliseconds(timeoutMilliseconds);

var content = new FormUrlEncodedContent(formData);
var response = client.PostAsync(url, content).GetAwaiter().GetResult();

response.EnsureSuccessStatusCode();

return response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
}
}
</source>

== Visual Basic Dot Net 8 ==

<source lang = "vb">

' Visual Basic Dot Net 8
Private Function RestConsoleCommand(command, IP as String, Port as String) As Boolean '
Dim ConsoleLogin = $"http://{IP}:{Port}/StartSession/"

Dim Diction = New Dictionary(Of String, String) From {
{"USER", $"{AdminFirst} {AdminLast}"},
{"PASS", Settings.ConsolePassword}
}

Dim xmlresponse = HttpHelper.PostForm(ConsoleLogin, Diction, 2000) 'Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>
Dim parser = New XmlDocument()
Try
parser.LoadXml(xmlresponse)
Dim sessionNode = parser.SelectSingleNode("ConsoleSession/SessionID")
If sessionNode Is Nothing Then
Return False
End If
Dim sessionID = sessionNode.InnerText

'POST http://foo.bar:8002/SessionCommand/
'Parameters: sessionID, COMMAND

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/SessionCommand/"
Diction = New Dictionary(Of String, String) From {
{"ID", sessionID},
{"COMMAND", command}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
parser.LoadXml(result)
sessionNode = parser.SelectSingleNode("ConsoleSession/Result")
If sessionNode Is Nothing Then
Return False
End If
Dim r = sessionNode.InnerText
If r = "OK" Then
CloseSession(sessionID)
Return True
Else
CloseSession(sessionID)
Return False
End If

Catch ex As Exception
ErrorLog(ex.Message)
End Try
Return False

End Function
Private Function CloseSession(SessionId As String)

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/CloseSession/"
Dim Diction = New Dictionary(Of String, String) From {
{"ID", SessionId}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
End Function

Public Function PostForm(url As String, formData As Dictionary(Of String, String), timeoutMilliseconds As Integer) As String
Using client As New HttpClient()
client.Timeout = TimeSpan.FromMilliseconds(timeoutMilliseconds)

Dim content = New FormUrlEncodedContent(formData)

Dim responseTask = client.PostAsync(url, content)

'Block the current thread until the task Is complete And get the result
Dim response = responseTask.GetAwaiter().GetResult()

response.EnsureSuccessStatusCode() ' Throws an exception If the status code Is an Error

Dim responseBodyTask = response.Content.ReadAsStringAsync()

' Block to get the response body string
Return responseBodyTask.GetAwaiter().GetResult()
End Using
End Function

</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

RestConsole

2026-03-16T07:27:33Z

Ferd Frederix: /* Visual Basic Dot Net */

{{Quicklinks|RestConsole}}{{ReleaseInfo}}
== About ==
The REST console makes remote administration of the various OpenSimulator services possible.

The interface allows sending commands to the server and retrieving command output. Sending and receiving data is done through RESTful HTTP calls.

While sending is very straightforward, receiving is not. Receiving uses reverse HTTP, performing a long poll to a CAPS URI.

In order to make the protocol more efficient, the help functionality has been pushed to the client side. Rather than sending each keystroke to the server, only validated command lines are sent. To make this possible, the server sends a burst-on-connect of data, which is the tree of allowed commands and their help information. This can be used by the client to create the "help" command output locally as well as provide command line help interactively.

The sample console client, OpenSim.ConsoleClient.exe, shows how this is done.

== Usage ==
In order to use the remote console, start up OpenSimulator services with parameter <tt>-console rest</tt>.

Example for Robust server in grid mode:
mono Robust.exe -console rest

Example for simulators (both in grid and standalone mode):
mono OpenSim.exe -console rest

== Syntax ==
We take the OpenSimulator services address <nowiki>http://foo.bar:8002</nowiki> as example here.

First start a new session by sending a HTTP POST request. User name and password should match the settings for <tt>ConsoleUser</tt> and <tt>ConsolePass</tt> in section <tt>[Network]</tt> of OpenSim.ini.<br />
Parameters: USER, PASS
<nowiki>http://foo.bar:8002/StartSession/</nowiki>
Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Now we got the SessionID, which can be used to send a command and to receive output. First, retrieve the console scrollback buffer.<br />
Parameters: none
<nowiki>http://foo.bar:8002/ReadResponses/<SessionID>/</nowiki>
Return: (XML) <ConsoleSession><Line Number=x Level=l Prompt=p Command=c Input=i></Line></ConsoleSession><br />
The reply contains all lines currently in the buffer. Subsequent fetches will only retrieve new lines. The fetch will hold for up to 30 seconds if there is no data, then return an error. The client is expected to try again (polling).
The attributes are as follows:
Number = The line number (1 based)
Level = The level this is to be logged as
Prompt = bool, true if the output on this line is a prompt
Command = bool, true if the prompt is for a command
Input = bool, true if the output is eachoed input

Use the SessionID as ID parameter, and send a POST request again.<br />
Parameters: ID, COMMAND
<nowiki>http://foo.bar:8002/SessionCommand/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
If everything went well, the command should have been executed. Try another command.

When you want to close down the connection, send a POST request again.<br />
Parameters: ID
<nowiki>http://foo.bar:8002/CloseSession/</nowiki>
Return: (XML) <ConsoleSession><Result></Result></ConsoleSession><br />
The session is closed, and you have to log in again, when you want to send a command again.

= Clients =

== C# ==

A C# client is included with the Opensimulator distribution. It is rudimentary and not updated to the latest protocol versions.

== Qt ==

The Qt 5 based client is at https://github.com/MelanieT/OpenSimConsoleClient

= Binaries =
Windows: http://opensimulator.org/downloads/ConsoleClient.zip
Mac: http://opensimulator.org/downloads/ConsoleClient.dmg
Linux: TBD

= Examples =

== NOTE ==

Some of the examples below are for an older version of the interface. They may work to a degree but need to be revised.

=== node.js ===

<source lang="javascript">
/*
| This piece of code is published by thomax (tx0h) (c) 2018 under the
| Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
|
| I removed my previous python approach because blueman made a better
| version and it was outdated. Here is a node.js variant.
*/

const readline = require('readline');
var Client = require('node-rest-client').Client;
var client = new Client();
var session_id;
var base_url = "http://127.0.0.1:9000";

// set http header
var headers = {
"Content-Type": "application/x-www-form-urlencoded",
"User-Agent": "nodejs-console/0.01"
};

// open session
function open_session() {
var args = {
data: {
"USER": "Test",
"PASS": 'secret'
},
headers,
};

client.post(base_url + "/StartSession/", args, function (data, response) {
session_id = data.ConsoleSession.SessionID;
read_session_buffer();
});
}

// close session
function close_session() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/CloseSession/", args, function (data, response) {
console.log("close_session: "+response);
});

console.log('Have a great day!');
process.exit(0);
}

// read all the lines from the console buffer and print them
function read_session_buffer() {
args = {
data: { "ID": session_id },
headers
};

client.post(base_url + "/ReadResponses/"+session_id+"/", args, function (data, response) {
if(data.ConsoleSession.Line) {
var i;
for(i=0; i < data.ConsoleSession.Line.length; i++) {
if(data.ConsoleSession.Line[i]._) {
console.log(data.ConsoleSession.Line[i]._);
}
}
rl.prompt();
}
});
}

// execute the command from the prompt
function execute_cmd(cmd) {
args = {
data: {
"ID": session_id,
"COMMAND": cmd
},
headers
};

client.post(base_url + "/SessionCommand/", args, function (data, response) {
});
}

// here we go.
open_session();

// prepare readline
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
prompt: 'REST CONSOLE> '
});
rl.prompt();

// hunt for events
rl.on('line', (line) => {
switch (line.trim()) {
case 'quit':
close_session();
break;
default:
if(line.length > 0) {
execute_cmd(line.trim());
}
break;
}
read_session_buffer();
rl.prompt();
}).on('close', () => {
close_session();
});
</source>

== Visual Basic Dot Net 8 ==

<source lang = "vb">

' Visual Basic Dot Net 8
Private Function RestConsoleCommand(command, IP as String, Port as String) As Boolean '
Dim ConsoleLogin = $"http://{IP}:{Port}/StartSession/"

Dim Diction = New Dictionary(Of String, String) From {
{"USER", $"{AdminFirst} {AdminLast}"},
{"PASS", Settings.ConsolePassword}
}

Dim xmlresponse = HttpHelper.PostForm(ConsoleLogin, Diction, 2000) 'Return: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>
Dim parser = New XmlDocument()
Try
parser.LoadXml(xmlresponse)
Dim sessionNode = parser.SelectSingleNode("ConsoleSession/SessionID")
If sessionNode Is Nothing Then
Return False
End If
Dim sessionID = sessionNode.InnerText

'POST http://foo.bar:8002/SessionCommand/
'Parameters: sessionID, COMMAND

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/SessionCommand/"
Diction = New Dictionary(Of String, String) From {
{"ID", sessionID},
{"COMMAND", command}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
parser.LoadXml(result)
sessionNode = parser.SelectSingleNode("ConsoleSession/Result")
If sessionNode Is Nothing Then
Return False
End If
Dim r = sessionNode.InnerText
If r = "OK" Then
CloseSession(sessionID)
Return True
Else
CloseSession(sessionID)
Return False
End If

Catch ex As Exception
ErrorLog(ex.Message)
End Try
Return False

End Function
Private Function CloseSession(SessionId As String)

Dim ConsoleCommandUrl = $"http://{Settings.PublicIp}:{Settings.HttpPort}/CloseSession/"
Dim Diction = New Dictionary(Of String, String) From {
{"ID", SessionId}
}

Dim result = PostForm(ConsoleCommandUrl, Diction, 2000)
End Function

Public Function PostForm(url As String, formData As Dictionary(Of String, String), timeoutMilliseconds As Integer) As String
Using client As New HttpClient()
client.Timeout = TimeSpan.FromMilliseconds(timeoutMilliseconds)

Dim content = New FormUrlEncodedContent(formData)

Dim responseTask = client.PostAsync(url, content)

'Block the current thread until the task Is complete And get the result
Dim response = responseTask.GetAwaiter().GetResult()

response.EnsureSuccessStatusCode() ' Throws an exception If the status code Is an Error

Dim responseBodyTask = response.Content.ReadAsStringAsync()

' Block to get the response body string
Return responseBodyTask.GetAwaiter().GetResult()
End Using
End Function

</source>

=== Python (Updated) ===

<source lang="python">
#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

def __init__(self, addr):
self.addr = addr
url = self.addr + 'StartSession/'

params = urllib.urlencode({
'USER': 'username', # REST username
'PASS': 'userpass' # REST password
})
data = urllib2.urlopen(url, params).read()
print data

dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('SessionID')
self.sessionid = elem[0].childNodes[0].nodeValue
elem = dom.getElementsByTagName('Prompt')
self.prompt = elem[0].childNodes[0].nodeValue + '# '

def close(self):
url = self.addr + 'CloseSession/'
params = urllib.urlencode({
'ID': self.sessionid
})
print urllib2.urlopen(url, params).read()

def do_cmd(self, cmd):
url = self.addr + 'SessionCommand/'
params = urllib.urlencode({
'ID': self.sessionid,
'COMMAND': cmd
})
data = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(data)
elem = dom.getElementsByTagName('Result')
return elem[0].childNodes[0].nodeValue

def read_buffer(self):
url = self.addr + 'ReadResponses/' + self.sessionid + '/'
params = urllib.urlencode({
'ID': self.sessionid
})

# print urllib2.urlopen(url, params).read()

result = urllib2.urlopen(url, params).read()
dom = xml.dom.minidom.parseString(result)

elem = dom.getElementsByTagName('Line')
for line in elem:
x0 = line.childNodes[0].nodeValue
x1 = str.replace(str(x0),':','~',2)
x2 = x1.split("~")
for lv in x2[2:]:
if not '+++' in lv:
print lv

# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
if cmd != "":
if 'OK' in console.do_cmd(cmd):
console.read_buffer()
cmd = raw_input("%s " % console.prompt)

console.close()

</source>

=== JavaScript/HTML ===

<pre>
<html>
<head>




<script type="text/javascript">

var sessionId;
var hostUrl;

function StartSession(url, user, password) {
hostUrl = url;
var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
};

function ReadResponses() {
var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
var lines = response.getElementsByTagName("Line");
for (var i = 0; i < lines.length; ++i) {
var element = document.createElement("div");
element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
document.getElementById("output").appendChild(element);
};
document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
};

function Command(cmd) {
void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
};

function CloseSession() {
void SendRequest("/CloseSession/", "ID=" + sessionId);
};

function SendRequest(path, data) {
var request = new XMLHttpRequest();
request.open("POST", hostUrl + path, false);
request.send(data);
return request.responseXML;
};

window.onunload = CloseSession;

</script>
</head>
<body>

<form action="#" onsubmit="
StartSession(this.address.value, this.user.value, this.password.value);
ReadResponses();
return false">
<input name="address" type="text" value="http://localhost:9000" />
<input name="user" type="text" value="ConsoleUser" />
<input name="password" type="text" value="ConsolePass" />
<input type="submit" value="Login" />
</form>

<div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

<form action="#" onsubmit="
Command(this.command.value);
ReadResponses();
return false">
<input type="text" name="command" value="Enter command here" size="40"/>
<input type="submit" value="Send Command" />
</form>

</body>
</html>
</pre>

Load Oar 0.9.0+

2025-03-17T00:47:40Z

Ferd Frederix: /* Parameters */ clarify when to use command

{{Quicklinks}}

= Load Oar Console Command =

This page provides information on the 'load oar' console command from OpenSimulator version 0.9.0 onwards.

Once you have saved regions in OAR files, the 'load oar' console command will load the OAR file into the current region. There are many parameters that enable replacing the region's current contents or merging the OAR file's contents with the objects, terrain and parcels already in the region.

'''Note: If you are using a version of OpenSimulator less than 0.9.0 then please see the original [[Load Oar]] page.'''

== Parameters ==
The load oar command in OpenSimulator version 0.9.0 onwards has the format:

<tt>load oar [parameters] OARFILE</tt>

where "OARFILE" is the path to the OAR file to read in, and "[parameters]" is zero or more optional parameters from the following list:

{| class="wikitable"
! style="width: 10em" | Parameter
! Since Version
! Description
|-
| <tt>--merge</tt>
| 0.6.8
| Specify to merge the contents of the reading OAR with the existing contents in the region.
|-
| <tt>--skip-assets</tt>
| 0.6.9
| If set, this will not load any of the assets from the OAR, though all other data will be loaded. This saves a lot of time and database operations if loading an OAR multiple times on a grid -- specify <tt>--skip-assets</tt> after the first time the OAR is loaded on a grid as the assets would have already been loaded the first time the OAR files was loaded.
|-
| <tt>--rotation</tt>
| 0.8
| The degrees to rotate all the objects loaded from the source OAR. This rotates terrain, parcel data and objects (prims) and is degrees counter-clockwise.
|-
| <tt>--rotation-center</tt>
| 0.8, but deprecated in 0.9
| The center around which to rotate objects on load. From 0.9.0 the source region's data is always rotated around it's center, prior to cutting a piece out and placing it. The parameter will likely be removed in 0.9.1
|-
| <tt>--bounding-origin</tt>
| 0.9
| The SW corner of a bounding cubiod that is used to 'cut out' data from the source OAR
|-
| <tt>--bounding-size</tt>
| 0.9
| The size of the bounding cuboid used to 'cut out' data from the source OAR
|-
| <tt>--displacement</tt>
| 0.8
| Specify a displacement that is added to all data as it is added to the destination region. The displacement MUST be specified as "<x,y,z>". So, for instance, to load an OAR from a 256x256 region into the middle of a larger 512x512 region, the parameter would be <tt>--displacement "<128,128,0>"</tt>. Note that you can specify a "Z" displacement which will move the objects up or down. Thus <tt>--displacement "<0,0,1000>"</tt> will put all the OAR's objects up high for a sky box.

The displacement is also applied to the terrain if it is included. The 'z' component is added to the terrain's heights.
|-
|
| 0.9
| Displacement is the offset into the destination region after the data from the source region has been rotated and cropped.
|-
| <tt>--no-objects</tt>
| 0.8
| Don't load any scene objects.
|-
| <tt>--force-assets</tt>
| 0.9.3 dev
| If you add option --force-assets to load oar, this will force replace of assets in region cache (will also try to upload but service will most likely refuse). Avoid using unless trying to do some recovery. Currently in Dev Master at commit #af75c37543eda [2025-02-11 01:00:35]
|-
| <tt>--force-terrain</tt>
| 0.8
| Force terrain loading on --merge. Normally, --merge does not overwrite the existing region's terrain.
|-
| <tt>--force-parcels</tt>
| 0.8
| Force parcel loading on --merge. Normally, --merge does not overwrite the existing region's parcel data.
|-
| <tt>--default-user "<first-name> <last-name>"</tt>
| 0.8
| Instead of setting object ownership to the estate owner, assign it to the named user. This only applies to objects that have UUIDs that do not match any user account in the receiving grid's installation. There is currently no option that will force a change of owner for all loaded objects no matter whether they match a user in the receiving installation. One workaround to achieve this would be to save the OAR with the --publish "save oar" option to strip owner information and then reload it.
|-
| <tt>--debug</tt>
| 0.9
| When --debug is specified the command will output more information onto the console about where objects and parcels are being placed
|}

== Notes On Regions of Different Sizes ==
With the addition of regions that have a size that can be a multiple of 256x256 (i.e. a [[Varregion]]) there is the possibility of loading OARs to and from regions of different sizes.
The load oar command now fully supports this and will load both smaller regions into larger ones and (cut out) pieces of larger regions into smaller ones. Parcel data is now handled correctly too.

= Example Uses =

== Replacing a region's contents with what's in an OAR file ==
Replacing a region with an OAR file for a region of the same size is as simple as:

<tt>load oar NewRegion.oar</tt>

== Merging together four region's worth of contents ==
Say you have four adjacent 256x256 region ('Region00.oar', 'Region01.oar', ...) and you want to load them into a new 512x512 [[Varregion]] ('BiggerRegion'). The commands would be:

<tt>change region BiggerRegion</tt>
<tt>load oar Region00.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <0,256,0> Region01.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <256,0,0> Region10.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <256,256,0> Region11.oar</tt>

== Loading a 256x256 region's contents into the middle of a 512x512 sized region ==
If you have an OAR file for a 256x256 region ('LegacyRegion.oar' for instance) and you want to set it into the middle of a 512x512 region with the loaded region rotated by 30 degrees without messing up the rest of the larger region, the command would be:

<tt>load oar --merge --force-terrain --force-parcels --rotation 30 --displacement <128,128,0> LegacyRegion.oar</tt>

== Loading part of a 512x512 VarRegion into a standard 256x256 sized region ==
Say you have a 512x512 [[Varregion]] with an island in the middle that's about the size of standard region (256x256m), you could use the following command to rotate it, cut it out and place it in the standard region:

<tt>load oar --rotation 90 --bounding-origin <128,128,0> --bounding-size <256,256,4096> VarRegion.oar</tt>

= Visualising how it works =

The new 'load oar' parameters work in the following order and this is *important to remember*:

<tt>--rotation</tt> -359 to +359 degress. The source region is rotated by the desired amount anticlockwise in degrees. If not specified then no rotation takes place. The coordinates within the source region are the same after rotation, so for example the middle of a 256x256 region will still be at <128, 128> after a 45 degree rotation, but the original SW corner will now be at new coordinates <128, -53>.

<tt>--bounding-origin <x, y, z></tt>
<tt>--bounding-size <x, y, z></tt> The (possibly rotated) source region is then cropped to a cube or rectangular cuboid defined by the coordinates given.

The resultant cuboid will then be placed at <tt><0, 0, 0></tt> in the destination region unless modified by:

<tt>--displacement <x, y, z></tt> The rotated and cropped data is offset into the destination region by this amount.

Some things to note:

<tt>--rotation</tt> applies to all of the source region's data, that is terrain, parcels and objects (prims). Both terrain, and even more so, parcels do not rotate well using arbitary rotations like 45 degrees as the edges will become jagged, but it's still supported.

== In Pictures ==
The following four diagrams attempt to show examples of the work flow for various combinations of source and destination region sizes:

[[Image:standard-to-standard.png|800px|left|standard to standard]]

[[Image:standard-to-var.png|800px|left|standard to var]]

[[Image:var-to-standard.png|800px|left|var to standard]]

[[Image:var-to-var.png|800px|left|var to var]]

[[Category:Users]]
[[Category:Support]]
[[Category:Tech Reference]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Server Commands

2025-03-17T00:44:48Z

Ferd Frederix: /* Asset Commands */ * fcache clearnegatives

{{Quicklinks|Server_Commands}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance find <uuid-or-start-of-uuid> - Find out which avatar uses the given asset as a baked texture, if any.
* appearance rebake <first-name> <last-name> - Send a request to the user's viewer for it to rebake and reupload its appearance textures.
* appearance send [<first-name> <last-name>] - Send appearance data for each avatar in the simulator to other viewers.
* appearance show [<first-name> <last-name>] - Show appearance information for avatars.

Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache clearnegatives - just clear negative cache entries if enabled
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object id <UUID-or-localID> - Delete a scene object by uuid or localID. Pre 0.7.5, this was "delete object uuid".
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object id <UUID-or-localID> - Show details of a scene object with the given UUID or localID. Pre 0.7.5, this was "show object uuid".
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part id <UUID-or-localID> - Show details of a scene object parts with the given UUID or localID. Pre 0.7.5, this was "show part uuid".

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
:Flags can be one of the following:
:'''DefaultRegion''' Used for new Rez. Random if multiple defined
:'''FallbackRegion''' Regions we redirect to when the destination is down
:'''RegionOnline''' Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
:'''NoDirectLogin''' Region unavailable for direct logins (by name)
:'''Persistent''' Don't remove on unregister
:'''LockedOut''' Don't allow registration
:'''NoMove '''Don't allow moving this region
:'''Reservation''' This is an inactive reservation
:'''Authenticate''' Require authentication
:'''Hyperlink''' Record represents a HG link
:'''DefaultHGRegion''' Record represents a default region for hypergrid teleports only.
:Note: flags are additive, there is no way to unset them from the console.
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file. (see note1)
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

Note1 : If you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY> where regionX and regionY are the coordinates of the bottom-left region.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

=== [[YEngine]] Commands ===
* yeng help
* yeng reset -all | <part-of-script-name>
* yeng resume - resume script processing
* yeng suspend - suspend script processing
* yeng ls -full -max=<number> -out=<filename> -queues -topcpu
* yeng cvv - show compiler version value
* yeng mvv [<newvalue>] - show migration version value
* yeng tracecalls [yes | no]
* yeng verbose [yes | no]
* yeng pev -all | <part-of-script-name> <event-name> <params...>

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [Email] [Primary UUID] [Model} - creates a new user
:or just: create user - and server prompts for all data
:
:If UUID is nul or whitespace a UUID will be generated for you.
:
:Model is the "first lastname" of another user, that user's outfit will be cloned to the new user.
:
* reset user password - This command ''sets'' a new password for a user and directly updates the database. It does not ''reset'' the password to a default or temporary value, as the term might suggest.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping - Link a HyperGrid region. Not sure how this differs from link-mapping.

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Inventory Archives

2025-03-16T23:32:35Z

Ferd Frederix: /* save iar */ added option --skipbadassets to iar save.

{{Quicklinks}}
<br />

= Introduction =

OpenSimulator Inventory Archives (IARs) are a means by which inventory folders and items can be saved offline to a single file (an IAR). This file can then be loaded into a different OpenSimulator installation.

Like [[OpenSim Archives]], IARs save all the necessary asset data required to fully restore the items including textures, sounds, scripts and objects contained in the inventory of other objects.

IARs have been enabled in OpenSimulator since Git revision 5a64ca (OpenSimulator 0.6.7 and later).

= Usage =

IARs are saved and loaded from the region console. By default, they are saved to the /bin directory of your installation, and an IAR file must be located in the /bin directory to be imported.

== save iar ==

The command to save an IAR on the region console is

save iar [-h|--home=<url>] [-v|--verbose] [--noassets] [--perm=<permissions>] [--skipbadassets] <user-name> <path> <password> [<filename>]

where

* <user-name> is the name of the user to save inventory from

* <path> is the path to an inventory item or folder. If the path is for a folder, that folder and all its contents (both descendant folders and items) are saved. If the path is for an item, then only that item is saved.

Components of the path are separated by a forward slash ("/"). If you need to specify a path with spaces, you can surround the whole thing with double quotation marks (e.g. "Folder A/Folder B").

You can specify that the contents of a folder should be saved rather than the folder itself using the * wildcard. For instance, "a/b/*" will save the contents of folder b but not folder b itself.

If a name or folder contains a forward slash ("/") then it can be escaped with the backslash (i.e. "\/") to stop it being seen as a path separator. Back slashes themselves need to be escaped with another backslash (i.e. "\\").

One further issue here is that it's not possible to distinguish between identically named folders or items on the path - the workaround is to rename your items/folders if you need to specify them in the path :)

* <password> is the password of the user.

* <filename> is an optional filename for the IAR. If none is supplied, then the filename user-inventory.iar is used in the current directory. I recommend that IARs have the .iar extension.

=== Switches ===
* If the option --skipbadassets is added, this will skip inventory items with missing or empty parts. Only in code after 0.9.3 (dev) commit #b13c4c as of [2025-02-10 22:52:53]
* If the --noassets option is specified, then the archive will be saved without assets. This can be handy if you're backing up the asset database separately and don't want the expense of including all the assets in each archive.
* --home=<url> is the URL of this world's profile service. It is not required that the profile service is operational; the information will be saved, and it will be displayed wherever the archive will be loaded. NOTE: the older --profile option (the previous name of this switch) produced IARs that are not compatible with OpenSimulator 0.7.0.2 and earlier; do not use this option if you want to produce a compatible IAR.
* --verbose prints out versbose saving messages
* If the --perm option is specified then items with insufficient permissions will not be saved to the IAR. This can be useful for grids that allow their customers to export their inventorys to IARs, because it ensures that exporting to IAR can't be used to bypass content permissions.

<permissions> specifies which permissions are required. It's a string that contains one or more of these characters:
* "C" = Copy
* "T" = Transfer
* "M" = Modify

=== Examples ===

Here's an example. Suppose you have an inventory structure like this

My Inventory
|
+-- FolderA
|
+-- FolderB
| |
| +-- ItemX
|
+-- ItemY

If you type

save iar John Doe FolderA PASSWORD my-items.iar

then FolderA and everything in FolderA (FolderB, ItemX and ItemY) will be saved into an IAR called my-items.iar. On the other hand, if you type

save iar John Doe FolderA/FolderB/ItemX PASSWORD my-items.iar

then only ItemX will be saved.

If there is a space in the path to the item, for example if John Doe's folder was named "Folder A" instead of "FolderA", then quotes around the path are necessary on the command line:

save iar John Doe "Folder A/FolderB/ItemX" PASSWORD my-items.iar

==== Saving an entire user's inventory ====

With save iar you can save your entire inventory as well as the contents of particular folders or individual items.

For instance, typing

save iar John Doe /* password

would save your entire inventory to user-inventory.iar (since no filename was given). This can later be restored using the --merge switch in the load iar command. For more details please see the "Restoring an entire user's inventory" section below.

'''Please note that for OpenSimulator 0.7.5 and before, the path for save iar must be specified as "/*" and not just "/". Specifying only "/" will still save the entire inventory but there will be a base folder called "My Inventory", which will be created on reload under a user's existing "My Inventory" folder.'''

'''From OpenSimulator git master dev code commit d54d3180 (Sat Feb 16 00:49:06 2013), "/" will also instead save the user's entire inventory without the "My Inventory" folder. This is because "My Inventory" is not actually a real folder but rather the name of the user's inventory. I believe this is more intuitive and it means that inventories saved using / can be restored using the load iar --merge function as well. This change will be in the next OpenSimulator release (0.7.6). -- [[User:Justincc|Justincc]] 02:26, 16 February 2013 (UTC)'''

== load iar ==

An IAR can be reloaded to an OpenSimulator instance with the load iar command

load iar [-m|--merge] <user-name> <path> <password> [<filename>]

where

* <user name> is the name of the user to whom to load the inventory

* <path> is the path to which the IAR should be loaded. This has to be a folder which already exists in "My Inventory". See the save iar command for more details.

* <password> is the password of the user.

* [<filename>] is an optional filename for the IAR. If none is specified, then the filename is assumed to be user-inventory.iar in the current directory.

=== Switches ===

* If the --merge option is given, then IAR items are loaded into the existing folder structure where possible, instead of always creating new folders.

=== Examples ===

1. Suppose that "David Hume" has recieved the my-items.iar saved above containing FolderA, FolderB, ItemX and ItemY. David Hume already has an inventory structure like this.

My Inventory
|
+-- Folder1
|
+-- Folder2
|
+-- Folder3

David wants to load the IAR to Folder3, so on the region console he executes

load iar David Hume Folder1/Folder3 password my-items.iar

After a little while he ends up with the folder structure

My Inventory
|
+-- Folder1
|
+-- Folder2
|
+-- Folder3
|
+-- FolderA
|
+-- FolderB
| |
| +-- ItemX
|
+-- ItemY

where ItemX and ItemY are ready for rezzing.

If there is a space in the path to the item, for example if David's folder was named "Folder 1" instead of "Folder1", then quotes around the path are necessary on the command line:

load iar David Hume "Folder 1/Folder3" password my-items.iar

From OpenSimulator 0.7 and onwards, you can also load IARs directly from web addresses. For example

load iar Betrand Russell Folder2 PASSWORD http://justincc.org/downloads/iars/my-great-items.iar

will load my-great-items.iar from the web into Folder2 of the user "Bertrand Russell".

2. Let's suppose that a user called Albert Camus has an existing inventory structure

My Inventory
|
+-- FolderA
| |
| +-- Item1
|
+-- FolderC
|
+-- Item2

and we execute

load iar --merge Albert Camus / PASSWORD my-items.iar

with the IAR saved above. Instead of creating a duplicate FolderA, this will instead result in the inventory structure

My Inventory
|
+-- FolderA
| |
| +-- FolderB
| | |
| | +-- ItemX
| |
| +-- Item1
| |
| +-- ItemY
|
+-- FolderC
|
+-- Item2

==== Restoring an entire user's inventory ====

The --merge option is useful if you are restoring a saved inventory to a new user account, since the base folders (Gestures, Landmarks, Objects, etc.) will not be duplicated.

For instance, if you have saved a whole user's inventory as detailed above, you can restore it to a freshly created user's inventory with the command.

load iar --merge Albert Camus / PASSWORD my-inventory.iar

= Use cases =

Possible uses

1. To distribute content to other OpenSimulator installations without need to transfer entire regions. One drawback with IARs for this use case is that creator names are not preserved unless the user has a profile on the target installation. One workaround is to include a notecard detailing the creator and license conditions of the content.

2. To backup a user's inventory. IARs are currently not that great for this. One can backup an entire inventory by giving a path of "/" to the save iar command. But a load IAR of the same will mean a duplicate set of root child 'standard' folders (Objects, Textures, Clothing, etc.). The loaded folders will not have any type icons.

== Current limitations ==

* IAR loading and saving is currently done on a single thread. This may lock up the console for a while with very large IARs. This should be addressed in the future

* Creator names are not preserved unless the profile exists on the target system. This problem may be addressed in the future.

== IAR Format ==

The OpenSimulator [[Inventory Archives|Inventory Archive (IAR)]] format is designed with three aims in mind:

# Make it easy for people to read and update individual items, assets, etc. within an archive.
# Make it easy to compose two inventory archives into a single inventory archive.
# Make it easy to compose archives from scratch.

Therefore, all the different entities (assets, items, etc.) are packaged in individual files (e.g. one for each asset) with human readable filenames and machine readable extensions (e.g. .jp2 for textures, .txt for notecards).
* [[IAR Format 0.1]]
* [[IAR Format 0.2]]
* [[IAR Format 0.3]]

= Bugs =

Please search the OpenSimulator Mantis for information on current IAR bugs.

FEB.23.2010:

There is a slight "quirk" with MySql in regards to Max_Allowed_Packet size, which the default is 1 Megabyte.  This is too small for some of the larger data blobs being stored.  It is recomended to increase the default value to 16 Megabytes.

Locate your MY.ini for MySql (EXAMPLE, in Windows it is located @ "C:\Program Files\MySQL\MySQL Server 5.1")  Modify this file to include the following under the mysqld section:

'''[mysqld]'''

# The TCP/IP Port the MySQL Server will listen on<br />port=3306<br />max_allowed_packet = 16M

'''Additional Reference''':  [http://dev.mysql.com/doc/refman/5.1/en/packet-too-large.html dev.mysql.com/doc/refman/5.1/en/packet-too-large.html]

= Current Status =

Operational. Bug reports appreciated through the usual Mantis channels.

Though we will strive to maintain compatibilty for old archives with newer OpenSimulator versions, please do not rely on these archives as your only backup for inventory.

= Downloadable IAR files =

* http://justincc.org/downloads/iars/my-great-items.iar - justincc's initial example IAR. (Broken link)
* http://www.aviefactory.com/Gene_Jacobs_Clothes.iar - Gene Jacobs Men's Clothing Collection (Original Creator)(Broken link)
* http://www.aviefactory.com/Genes_Female_Stuff.iar - Female Skins and Shapes (Found off the web)(Broken link)
* http://www.gridhop.net/IAR/lightshare.iar - [[User:Thomax|txOh]]'s LightShare controller. Useful only if you have [[LightShare]] enabled in OpenSim.ini.(Broken link)

Please feel free to place links to other IARs here.

= External Links =

[http://justincc.org/blog/category/iars/ http://justincc.org/blog/category/iars/] - articles by justincc on IARs, including tutorials, background information and possible future developments.(Broken link)

[http://www.metaverseink.com/blog/?p=29 The OpenSimulator Library just got more interesting] - Diva Canto's article on how to extend the OpenSimulator Library using IARs.

= See Also =

* [[OpenSim Archives|How to use OpenSimulator Archives (OAR)]]

[[Category:Users]]
[[Category:Support]]
[[Category:Tech Reference]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Load Oar 0.9.0+

2025-03-16T23:25:23Z

Ferd Frederix: /* Parameters */ added --force-assets - will need update of dev number on next release

{{Quicklinks}}

= Load Oar Console Command =

This page provides information on the 'load oar' console command from OpenSimulator version 0.9.0 onwards.

Once you have saved regions in OAR files, the 'load oar' console command will load the OAR file into the current region. There are many parameters that enable replacing the region's current contents or merging the OAR file's contents with the objects, terrain and parcels already in the region.

'''Note: If you are using a version of OpenSimulator less than 0.9.0 then please see the original [[Load Oar]] page.'''

== Parameters ==
The load oar command in OpenSimulator version 0.9.0 onwards has the format:

<tt>load oar [parameters] OARFILE</tt>

where "OARFILE" is the path to the OAR file to read in, and "[parameters]" is zero or more optional parameters from the following list:

{| class="wikitable"
! style="width: 10em" | Parameter
! Since Version
! Description
|-
| <tt>--merge</tt>
| 0.6.8
| Specify to merge the contents of the reading OAR with the existing contents in the region.
|-
| <tt>--skip-assets</tt>
| 0.6.9
| If set, this will not load any of the assets from the OAR, though all other data will be loaded. This saves a lot of time and database operations if loading an OAR multiple times on a grid -- specify <tt>--skip-assets</tt> after the first time the OAR is loaded on a grid as the assets would have already been loaded the first time the OAR files was loaded.
|-
| <tt>--rotation</tt>
| 0.8
| The degrees to rotate all the objects loaded from the source OAR. This rotates terrain, parcel data and objects (prims) and is degrees counter-clockwise.
|-
| <tt>--rotation-center</tt>
| 0.8, but deprecated in 0.9
| The center around which to rotate objects on load. From 0.9.0 the source region's data is always rotated around it's center, prior to cutting a piece out and placing it. The parameter will likely be removed in 0.9.1
|-
| <tt>--bounding-origin</tt>
| 0.9
| The SW corner of a bounding cubiod that is used to 'cut out' data from the source OAR
|-
| <tt>--bounding-size</tt>
| 0.9
| The size of the bounding cuboid used to 'cut out' data from the source OAR
|-
| <tt>--displacement</tt>
| 0.8
| Specify a displacement that is added to all data as it is added to the destination region. The displacement MUST be specified as "<x,y,z>". So, for instance, to load an OAR from a 256x256 region into the middle of a larger 512x512 region, the parameter would be <tt>--displacement "<128,128,0>"</tt>. Note that you can specify a "Z" displacement which will move the objects up or down. Thus <tt>--displacement "<0,0,1000>"</tt> will put all the OAR's objects up high for a sky box.

The displacement is also applied to the terrain if it is included. The 'z' component is added to the terrain's heights.
|-
|
| 0.9
| Displacement is the offset into the destination region after the data from the source region has been rotated and cropped.
|-
| <tt>--no-objects</tt>
| 0.8
| Don't load any scene objects.
|-
| <tt>--force-assets</tt>
| 0.9.3 dev
| If you add option --force-assets to load oar, this will force replace of assets in region cache. Currently in Dev Master at commit #af75c37543eda [2025-02-11 01:00:35]
|-
| <tt>--force-terrain</tt>
| 0.8
| Force terrain loading on --merge. Normally, --merge does not overwrite the existing region's terrain.
|-
| <tt>--force-parcels</tt>
| 0.8
| Force parcel loading on --merge. Normally, --merge does not overwrite the existing region's parcel data.
|-
| <tt>--default-user "<first-name> <last-name>"</tt>
| 0.8
| Instead of setting object ownership to the estate owner, assign it to the named user. This only applies to objects that have UUIDs that do not match any user account in the receiving grid's installation. There is currently no option that will force a change of owner for all loaded objects no matter whether they match a user in the receiving installation. One workaround to achieve this would be to save the OAR with the --publish "save oar" option to strip owner information and then reload it.
|-
| <tt>--debug</tt>
| 0.9
| When --debug is specified the command will output more information onto the console about where objects and parcels are being placed
|}

== Notes On Regions of Different Sizes ==
With the addition of regions that have a size that can be a multiple of 256x256 (i.e. a [[Varregion]]) there is the possibility of loading OARs to and from regions of different sizes.
The load oar command now fully supports this and will load both smaller regions into larger ones and (cut out) pieces of larger regions into smaller ones. Parcel data is now handled correctly too.

= Example Uses =

== Replacing a region's contents with what's in an OAR file ==
Replacing a region with an OAR file for a region of the same size is as simple as:

<tt>load oar NewRegion.oar</tt>

== Merging together four region's worth of contents ==
Say you have four adjacent 256x256 region ('Region00.oar', 'Region01.oar', ...) and you want to load them into a new 512x512 [[Varregion]] ('BiggerRegion'). The commands would be:

<tt>change region BiggerRegion</tt>
<tt>load oar Region00.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <0,256,0> Region01.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <256,0,0> Region10.oar</tt>
<tt>load oar --merge --force-terrain --force-parcels --displacement <256,256,0> Region11.oar</tt>

== Loading a 256x256 region's contents into the middle of a 512x512 sized region ==
If you have an OAR file for a 256x256 region ('LegacyRegion.oar' for instance) and you want to set it into the middle of a 512x512 region with the loaded region rotated by 30 degrees without messing up the rest of the larger region, the command would be:

<tt>load oar --merge --force-terrain --force-parcels --rotation 30 --displacement <128,128,0> LegacyRegion.oar</tt>

== Loading part of a 512x512 VarRegion into a standard 256x256 sized region ==
Say you have a 512x512 [[Varregion]] with an island in the middle that's about the size of standard region (256x256m), you could use the following command to rotate it, cut it out and place it in the standard region:

<tt>load oar --rotation 90 --bounding-origin <128,128,0> --bounding-size <256,256,4096> VarRegion.oar</tt>

= Visualising how it works =

The new 'load oar' parameters work in the following order and this is *important to remember*:

<tt>--rotation</tt> -359 to +359 degress. The source region is rotated by the desired amount anticlockwise in degrees. If not specified then no rotation takes place. The coordinates within the source region are the same after rotation, so for example the middle of a 256x256 region will still be at <128, 128> after a 45 degree rotation, but the original SW corner will now be at new coordinates <128, -53>.

<tt>--bounding-origin <x, y, z></tt>
<tt>--bounding-size <x, y, z></tt> The (possibly rotated) source region is then cropped to a cube or rectangular cuboid defined by the coordinates given.

The resultant cuboid will then be placed at <tt><0, 0, 0></tt> in the destination region unless modified by:

<tt>--displacement <x, y, z></tt> The rotated and cropped data is offset into the destination region by this amount.

Some things to note:

<tt>--rotation</tt> applies to all of the source region's data, that is terrain, parcels and objects (prims). Both terrain, and even more so, parcels do not rotate well using arbitary rotations like 45 degrees as the edges will become jagged, but it's still supported.

== In Pictures ==
The following four diagrams attempt to show examples of the work flow for various combinations of source and destination region sizes:

[[Image:standard-to-standard.png|800px|left|standard to standard]]

[[Image:standard-to-var.png|800px|left|standard to var]]

[[Image:var-to-standard.png|800px|left|var to standard]]

[[Image:var-to-var.png|800px|left|var to var]]

[[Category:Users]]
[[Category:Support]]
[[Category:Tech Reference]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

RemoteAdmin:admin shutdown

2024-08-01T05:32:04Z

Ferd Frederix: /* Optional Parameters */ add missing parameters for admin_shutdown command

'''admin_shutdown''' remotely allows to shutdown the simulator. Agents in the Region recieve a warning. All regions in the instance will be shut down. When using the optional ''shutdown'' and ''milliseconds'' parameter the shut down is delayed by the specified miliseconds.

=== Enabling admin_shutdown ===
If not all functions are enabled, use admin_shutdown to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_shutdown,...
</source>

== Parameters ==
=== Required Parameters ===
No parameters are required.

=== Optional Parameters ===
These parameters are optional and do not need to be set
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''shutdown''
| use shutdown together with ''milliseconds'' to trigger a delayed shutdown.
| "delayed"
|-
| ''milliseconds''
| milliseconds till region shuts down.
| "delayed"
|-
| ''noticetype''
| send a notification to users in region
| "dialog"
|-
| ''noticetype''
| send a general alert
| "none"
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true
|-
| ''accepted''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|}

=== Error messages ===

== Notes ==
* Returned Parameter ''success'' only implemeted for true, patch in work by Michelle Argus to implement ''success'' fully

== Example ==
=== PHP ===
This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].

<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_user (multiple parameters)
$parameters = array('region_id'=> $region_id, 'shutdown' => 'delayed', 'milliseconds' => 60000);
$myRemoteAdmin->SendCommand('admin_shutdown', $parameters);
?>
</source>

[[Category:RemoteAdmin]]
[[Category:RemoteAdmin Commands]]

RemoteAdmin:admin shutdown

2024-08-01T05:25:22Z

Ferd Frederix: /* Required Parameters */

'''admin_shutdown''' remotely allows to shutdown the simulator. Agents in the Region recieve a warning. All regions in the instance will be shut down. When using the optional ''shutdown'' and ''milliseconds'' parameter the shut down is delayed by the specified miliseconds.

=== Enabling admin_shutdown ===
If not all functions are enabled, use admin_shutdown to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_shutdown,...
</source>

== Parameters ==
=== Required Parameters ===
No parameters are required.

=== Optional Parameters ===
These parameters are optional and do not need to be set
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''shutdown''
| use shutdown together with ''milliseconds'' to trigger a delayed shutdown.
| "delayed"
|-
| ''milliseconds''
| miliseconds till region shuts down.
| "delayed"
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true
|-
| ''accepted''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|}

=== Error messages ===

== Notes ==
* Returned Parameter ''success'' only implemeted for true, patch in work by Michelle Argus to implement ''success'' fully

== Example ==
=== PHP ===
This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].

<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_user (multiple parameters)
$parameters = array('region_id'=> $region_id, 'shutdown' => 'delayed', 'milliseconds' => 60000);
$myRemoteAdmin->SendCommand('admin_shutdown', $parameters);
?>
</source>

[[Category:RemoteAdmin]]
[[Category:RemoteAdmin Commands]]

Server Commands

2024-03-22T14:56:55Z

Ferd Frederix: /* Estate Commands */ Must be a user UUID,m , drop the comma and m

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance find <uuid-or-start-of-uuid> - Find out which avatar uses the given asset as a baked texture, if any.
* appearance rebake <first-name> <last-name> - Send a request to the user's viewer for it to rebake and reupload its appearance textures.
* appearance send [<first-name> <last-name>] - Send appearance data for each avatar in the simulator to other viewers.
* appearance show [<first-name> <last-name>] - Show appearance information for avatars.

Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
:Flags can be one of the following:
:'''DefaultRegion''' Used for new Rez. Random if multiple defined
:'''FallbackRegion''' Regions we redirect to when the destination is down
:'''RegionOnline''' Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
:'''NoDirectLogin''' Region unavailable for direct logins (by name)
:'''Persistent''' Don't remove on unregister
:'''LockedOut''' Don't allow registration
:'''NoMove '''Don't allow moving this region
:'''Reservation''' This is an inactive reservation
:'''Authenticate''' Require authentication
:'''Hyperlink''' Record represents a HG link
:'''DefaultHGRegion''' Record represents a default region for hypergrid teleports only.
:Note: flags are additive, there is no way to unset them from the console.
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file. (see note1)
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

Note1 : If you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY> where regionX and regionY are the coordinates of the bottom-left region.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

=== [[YEngine]] Commands ===
* yeng help
* yeng reset -all | <part-of-script-name>
* yeng resume - resume script processing
* yeng suspend - suspend script processing
* yeng ls -full -max=<number> -out=<filename> -queues -topcpu
* yeng cvv - show compiler version value
* yeng mvv [<newvalue>] - show migration version value
* yeng tracecalls [yes | no]
* yeng verbose [yes | no]
* yeng pev -all | <part-of-script-name> <event-name> <params...>

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [Email] [Primary UUID] [Model} - creates a new user
:or just: create user - and server prompts for all data
:
:If UUID is nul or whitespace a UUID will be generated for you.
:
:Model is the "first lastname" of another user, that user's outfit will be cloned to the new user.
:
* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping - Link a HyperGrid region. Not sure how this differs from link-mapping.

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

PCampBot

2023-03-11T23:31:31Z

Ferd Frederix: /* Step 1: Create bot accounts */

{{Quicklinks}}

= Using pCampbot as of OpenSimulator 0.7.6 =
pCampBot has changed considerably in OpenSimulator development code. Here is the current usage statement that you'll get if you execute pCampBot.exe as of OpenSimulator 0.7.6.

<pre>
usage: pCampBot <-loginuri loginuri> [OPTIONS]
Spawns a set of bots to test an OpenSim region

-l, -loginuri loginuri for grid/standalone (required)
-s, -start start location for bots (optional). Can be "last", "home" or a specific location with or without co-ords (e.g. "region1" or "region2/50/30/90"
-firstname first name for the bots (required)
-lastname lastname for the bots (required). Each lastname will have <bot-number> appended, e.g. Ima Bot0
-password password for the bots (required)
-n, -botcount number of bots to start (default: 1) (optional)
-f, -from starting number for login bot names, e.g. 25 will login Ima Bot25, Ima Bot26, etc. (default: 0) (optional)
-c, -connect connect all bots at startup (optional)
-b, behaviours behaviours for bots. Comma separated, e.g. n,p,g. Default is p (required)
current options are:
p (physics - bots constantly move and jump around)
g (grab - bots randomly click prims whether set clickable or not)
n (none - bots do nothing)
t (teleport - bots regularly teleport between regions on the grid)
-wear folder from which to load appearance data, "no" if there is no such folder (default: no) (optional)
-h, -help show this message.
</pre>

You must have already created all the necessary bot accounts in the simulator before using pCampbot. It does not create these accounts on the fly.

Because pCampbot connects bots using the [http://lib.openmetaverse.org libopenmetaverse] library in the same manner that an ordinary viewer program would connect, you can use the pCampbot in 0.7.6 or later to test earlier versions of OpenSimulator.

The -wear option almost certainly doesn't work. The others are operational.

On using this facility you'll get a console command line similar to the one in OpenSimulator and Robust. Type "help" at this prompt to see further commands.

== Optional pCampbot.ini configuration ==
pCampbot has some further optional configuration options relating to detailed bot behaviour in pCampbot.ini.example. To change these from the defaults

cp pCampbot.ini.example pCampbot.ini

and change pCampbot.ini accordingly.

== Caveats ==

* A pCampBot synthetic bot load is still an extremely poor proxy for a 'real' connection (i.e. a real human being logging in with a viewer and doing all the things they expect to be able to do in a virtual world). Real connections are very likely to place different stresses on the simulator so real-world performance may be considerably different and poorer than synthetic load tests would suggest.

* There are some things you can do to improve this in pCampbot. For instance, if you have RequestObjectTextures set in pCampbot.ini then pCampbot will request textures for all objects it sees. This is both much less stressful than a real scenario (since for a particular sets of bots textures are only requested once) and more stressful (since there is never any caching).

* pCampbot does currently not work well if there are any surrounding regions. Avatars will currently just walk off into oblivion. You must either build fences or remove such regions. In testing so far, the presence of neighbouring regions does not have any great impact on performance in the region occupied by bots. However, these tests were performed with blank surrounding regions - surrounding regions containing objects will place more initial stress on the bot connections as object data is downloaded (and textures if this option is active).

== Example ==
Okay, let's suppose that we're on Linux and want to create a 5 bot synthetic load test on a region called myregion1. Depending on your bandwidth and the bot settings you can connect quite a large number of bots but for this example we will stick with 5. Here are the steps to take.

=== Step 1: Create bot accounts ===
The first step is to create 5 bot accounts, all with the same password. Each bot account must have the same first name and the same last name prefix. But each bot must also have its last name prefix appended its bot number, starting from 0. In this case, we want five bots, and lets suppose we will call them "ima bot". Then the five accounts that we want are

ima bot0
ima bot1
ima bot2
ima bot3
ima bot4

The classic way to create a user account is to do it by using the "create user" command on the OpenSimulator standalone or Robust service console, depending on whether one is running in standalone or grid mode. However, this can be laborious, particularly if one needs hundreds of bot accounts. There's a very basic python script at https://github.com/justincc/opensimulator-tools/blob/master/create-user-line-generator/src/culg.py ( dead link ) which will generate the user lines needed, giving each account a non-random UUID for later debugging purposes. The lines that this script generated can be pasted directly into the OpenSimulator console.

=== Step 2: Start pCampbot ===
The next step is to start up pCampbot with the required connection parameters. Let us suppose that you want to test against a region called "r1" on a local grid with a loginuri of <nowiki>http://192.168.1.2:8002</nowiki>. Let us assume that you've given the bots the password "plentyofruth". The command to run is then

mono --debug pCampBot.exe -loginuri <nowiki>http://192.168.1.2:8002</nowiki> -s r1 -firstname ima -lastname bot -password plentyofruth

This will start up pCampbot and you'll see a familiar console command line as you would on a simulator or Robust console. As with the other consoles, you can type "help" to get a list of commands.

As of OpenSimulator 0.7.6, pCampbot by default starts without automatically connecting the bots.

=== Step 3: Connect the bots ===
Once you're ready, type the command

conn

to start connecting the bots. You will see the connection messages on the console and if all goes well you'll see the bots appear on the region. The default bot behaviour is "physics", so the bots will start walking and jumping around to test and load up region physics.

A client connection is a complicated affair so you'll probably see many warnings and debug messages of different severity on the console. But as long as the bot it present in the region you can assume that the connection has succeeded.

=== Step 4: Assess performance ===
Now this is quite tricky, since there's currently no automated way of assessing simulator or connection performance. Manual ways to assess this include logging in a viewer to the same region to get a feel for avatar movement (e.g. is it jerky, is there rubberbanding, is chat delayed, etc.) and to see [[Client_side_monitoring|viewer statistics]] such as Ping Sim, Packet Loss, Physics Time (frame) and Spare Time (frame).

However, one needs to be extremely careful if logging in using a viewer on the same machine from which the bots are running. The bots should really be running from a different machine or ideally even from a different network in order to get a more accurate picture of current simulator performance.

One can also look at [[Monitoring|server side monitoring]], particularly "show stats clientstack" which will show various client stack related statistics (this is the part of the OpenSimulator code that handles receiving and sending of UDP messages from viewers). In particular, the InboxPacketsCount should be constantly 0 or near 0 - a build up here means that your simulator is receiving UDP packets quicker than it can process them.

=== Step 5: Disconnect bots ===
Once you've finished, you can disconnect the bots in an orderly fashion with the command

disconn

Once all the bots are disconnected you can exit pCampbot with the command

quit

or reconnect the bots if you want. You can also see the current connection status of bots with the command

show bots

at any time.

[[Category:Testing]]

PCampBot

2023-03-11T23:30:55Z

Ferd Frederix: underscore is no longer used in bot names.

{{Quicklinks}}

= Using pCampbot as of OpenSimulator 0.7.6 =
pCampBot has changed considerably in OpenSimulator development code. Here is the current usage statement that you'll get if you execute pCampBot.exe as of OpenSimulator 0.7.6.

<pre>
usage: pCampBot <-loginuri loginuri> [OPTIONS]
Spawns a set of bots to test an OpenSim region

-l, -loginuri loginuri for grid/standalone (required)
-s, -start start location for bots (optional). Can be "last", "home" or a specific location with or without co-ords (e.g. "region1" or "region2/50/30/90"
-firstname first name for the bots (required)
-lastname lastname for the bots (required). Each lastname will have <bot-number> appended, e.g. Ima Bot0
-password password for the bots (required)
-n, -botcount number of bots to start (default: 1) (optional)
-f, -from starting number for login bot names, e.g. 25 will login Ima Bot25, Ima Bot26, etc. (default: 0) (optional)
-c, -connect connect all bots at startup (optional)
-b, behaviours behaviours for bots. Comma separated, e.g. n,p,g. Default is p (required)
current options are:
p (physics - bots constantly move and jump around)
g (grab - bots randomly click prims whether set clickable or not)
n (none - bots do nothing)
t (teleport - bots regularly teleport between regions on the grid)
-wear folder from which to load appearance data, "no" if there is no such folder (default: no) (optional)
-h, -help show this message.
</pre>

You must have already created all the necessary bot accounts in the simulator before using pCampbot. It does not create these accounts on the fly.

Because pCampbot connects bots using the [http://lib.openmetaverse.org libopenmetaverse] library in the same manner that an ordinary viewer program would connect, you can use the pCampbot in 0.7.6 or later to test earlier versions of OpenSimulator.

The -wear option almost certainly doesn't work. The others are operational.

On using this facility you'll get a console command line similar to the one in OpenSimulator and Robust. Type "help" at this prompt to see further commands.

== Optional pCampbot.ini configuration ==
pCampbot has some further optional configuration options relating to detailed bot behaviour in pCampbot.ini.example. To change these from the defaults

cp pCampbot.ini.example pCampbot.ini

and change pCampbot.ini accordingly.

== Caveats ==

* A pCampBot synthetic bot load is still an extremely poor proxy for a 'real' connection (i.e. a real human being logging in with a viewer and doing all the things they expect to be able to do in a virtual world). Real connections are very likely to place different stresses on the simulator so real-world performance may be considerably different and poorer than synthetic load tests would suggest.

* There are some things you can do to improve this in pCampbot. For instance, if you have RequestObjectTextures set in pCampbot.ini then pCampbot will request textures for all objects it sees. This is both much less stressful than a real scenario (since for a particular sets of bots textures are only requested once) and more stressful (since there is never any caching).

* pCampbot does currently not work well if there are any surrounding regions. Avatars will currently just walk off into oblivion. You must either build fences or remove such regions. In testing so far, the presence of neighbouring regions does not have any great impact on performance in the region occupied by bots. However, these tests were performed with blank surrounding regions - surrounding regions containing objects will place more initial stress on the bot connections as object data is downloaded (and textures if this option is active).

== Example ==
Okay, let's suppose that we're on Linux and want to create a 5 bot synthetic load test on a region called myregion1. Depending on your bandwidth and the bot settings you can connect quite a large number of bots but for this example we will stick with 5. Here are the steps to take.

=== Step 1: Create bot accounts ===
The first step is to create 5 bot accounts, all with the same password. Each bot account must have the same first name and the same last name prefix. But each bot must also have its last name prefix appended with an underscore (_) and its bot number, starting from 0. In this case, we want five bots, and lets suppose we will call them "ima bot". Then the five accounts that we want are

ima bot0
ima bot1
ima bot2
ima bot3
ima bot4

The classic way to create a user account is to do it by using the "create user" command on the OpenSimulator standalone or Robust service console, depending on whether one is running in standalone or grid mode. However, this can be laborious, particularly if one needs hundreds of bot accounts. There's a very basic python script at https://github.com/justincc/opensimulator-tools/blob/master/create-user-line-generator/src/culg.py ( dead link ) which will generate the user lines needed, giving each account a non-random UUID for later debugging purposes. The lines that this script generated can be pasted directly into the OpenSimulator console.

=== Step 2: Start pCampbot ===
The next step is to start up pCampbot with the required connection parameters. Let us suppose that you want to test against a region called "r1" on a local grid with a loginuri of <nowiki>http://192.168.1.2:8002</nowiki>. Let us assume that you've given the bots the password "plentyofruth". The command to run is then

mono --debug pCampBot.exe -loginuri <nowiki>http://192.168.1.2:8002</nowiki> -s r1 -firstname ima -lastname bot -password plentyofruth

This will start up pCampbot and you'll see a familiar console command line as you would on a simulator or Robust console. As with the other consoles, you can type "help" to get a list of commands.

As of OpenSimulator 0.7.6, pCampbot by default starts without automatically connecting the bots.

=== Step 3: Connect the bots ===
Once you're ready, type the command

conn

to start connecting the bots. You will see the connection messages on the console and if all goes well you'll see the bots appear on the region. The default bot behaviour is "physics", so the bots will start walking and jumping around to test and load up region physics.

A client connection is a complicated affair so you'll probably see many warnings and debug messages of different severity on the console. But as long as the bot it present in the region you can assume that the connection has succeeded.

=== Step 4: Assess performance ===
Now this is quite tricky, since there's currently no automated way of assessing simulator or connection performance. Manual ways to assess this include logging in a viewer to the same region to get a feel for avatar movement (e.g. is it jerky, is there rubberbanding, is chat delayed, etc.) and to see [[Client_side_monitoring|viewer statistics]] such as Ping Sim, Packet Loss, Physics Time (frame) and Spare Time (frame).

However, one needs to be extremely careful if logging in using a viewer on the same machine from which the bots are running. The bots should really be running from a different machine or ideally even from a different network in order to get a more accurate picture of current simulator performance.

One can also look at [[Monitoring|server side monitoring]], particularly "show stats clientstack" which will show various client stack related statistics (this is the part of the OpenSimulator code that handles receiving and sending of UDP messages from viewers). In particular, the InboxPacketsCount should be constantly 0 or near 0 - a build up here means that your simulator is receiving UDP packets quicker than it can process them.

=== Step 5: Disconnect bots ===
Once you've finished, you can disconnect the bots in an orderly fashion with the command

disconn

Once all the bots are disconnected you can exit pCampbot with the command

quit

or reconnect the bots if you want. You can also see the current connection status of bots with the command

show bots

at any time.

[[Category:Testing]]

OpenSimConsoleClient/de

2022-12-26T18:41:03Z

Ferd Frederix: Melanie's last name was misspelled, add link to src

{{Quicklinks|OpenSimConsoleClient}}

{{ReleaseInfo}}

= OpenSimConsoleClient von Melanie Theilker =

== Schritt eins der Download ==

Download:

Windows: http://opensimulator.org/downloads/ConsoleClient.zip

Mac: http://opensimulator.org/downloads/ConsoleClient.dmg

Src: https://github.com/MelanieT/OpenSimConsoleClient

== Schritt zwei die Konfiguration ==

OpenSim.ini Konfigurationsdatei öffnen und unter abschnitt Network Wunschname und Wunschpasswort eingeben, dabei merken sie sich die unter http_listener_port angegebene Nummer.

[Network]
ConsoleUser = "Wunschname"
ConsolePass = "Wunschpasswort"
console_port = 0
http_listener_port = 9000

== Schritt drei der Start ==

Der OpenSimulator muss nun mit der Option „OpenSim.exe -console rest“ gestartet werden.

Linux mit screen:
screen -fa -S OS -d -U -m mono OpenSim.exe -console rest

== Schritt vier der OpenSimConsoleClient ==

ConsoleClient.zip entpacken und dann ConsoleClient.exe starten.

Oben unter Connection New auswählen:

Connection > Hier einen Namen der zu der Serververbindung passt eingeben.

Host > Hier die URL zum Server eingeben 192.16.8.1.100 oder meinserver.de je nachdem halt.

Port > Den gemerkten Port hier eingeben.

User > Wunschname den man sich ausgesucht hat hier eingeben.

Passwort > Hier das Wunschpasswort eingeben welches man sich ausgesucht hat.

Mit dem anklicken von OK wird das gespeichert und auf der rechten Seite angezeigt.

Im gleichen Schema kann man seine ganzen Server eintragen.

Jetzt klickt man auf einen der auf der rechten Seite aufgelisteten Server,

wähle oben Connection und Connect schon ist man auf dem Server in der OpenSim Konsole.

[[Category:German Translations]]

OpenSimConsoleClient

2022-12-26T18:40:02Z

Ferd Frederix: Melanie's name was misspelled

{{Quicklinks}}

OpenSimConsoleClient by Melanie Thielker

Download:

Windows: http://opensimulator.org/downloads/ConsoleClient.zip

Mac: http://opensimulator.org/downloads/ConsoleClient.dmg

Src: https://github.com/MelanieT/OpenSimConsoleClient

Open the OpenSim.ini configuration file and enter your desired name and password under the Network section, remembering the number under http_listener_port.

[Network]
ConsoleUser = "desired name"
ConsolePass = "desired password"
console_port = 0
http_listener_port = 9000

OpenSimulator must now be started with the option OpenSim.exe -console=rest“ start option

Linux with screen:
screen -fa -S OS -d -U -m mono OpenSim.exe -console=rest

Unzip ConsoleClient.zip and then start ConsoleClient.exe.

Select New under Connection at the top:

Connection > Enter a name that matches the server connection.

Host > Enter the URL to the server here 192.16.8.1.100 or DNS name.

Port > Enter the region HTTP port here.

User > Enter the name you have chosen here.

Password > Enter the password for the user.

Clicking on OK saves this and displays it on the right-hand side.

You can enter your entire server in the same scheme.

Now click on one of the servers listed on the right-hand side, choose Connection at the top and Connect and you are on the server in the console.

Advantages of the new console: you can enter the console and commands in just a few seconds without having to bother with the screen command first.

Disadvantage the whole program does not work properly, although it is already quite useful.

OpenSimConsoleClient

2022-12-26T17:42:23Z

Ferd Frederix: Translate to English

{{Quicklinks}}

OpenSimConsoleClient by Melanie Thilker

Download:

Windows: http://opensimulator.org/downloads/ConsoleClient.zip

Mac: http://opensimulator.org/downloads/ConsoleClient.dmg

Open the OpenSim.ini configuration file and enter your desired name and password under the Network section, remembering the number given under http_listener_port.

[Network]
ConsoleUser = "desired name"
ConsolePass = "desired password"
console_port = 0
http_listener_port = 9000

OpenSimulator must now be started with the option OpenSim.exe -console rest“ gestartet werden.

Linux with screen:
screen -fa -S OS -d -U -m mono OpenSim.exe -console=rest

Unzip ConsoleClient.zip and then start ConsoleClient.exe.

Select New under Connection at the top:

Connection > Enter a name that matches the server connection.

Host > Enter the URL to the server here 192.16.8.1.100 or DNS name.

Port > Enter the region HTTP port here.

User > Enter the name you have chosen here.

Password > Enter the password for the user.

Clicking on OK saves this and displays it on the right-hand side.

You can enter your entire server in the same scheme.

Now click on one of the servers listed on the right-hand side, choose Connection at the top and Connect and you are on the server in the console.

Advantages of the new console: you can enter the console and commands in just a few seconds without having to bother with the screen command first.

Disadvantage the whole program does not work properly, although it is already quite useful.

Talk:OpenSimConsoleClient

2022-12-26T17:28:07Z

Ferd Frederix: Must be started with parameter "-console=rest",

Must be started with parameter "-console=rest", not with a space

OpenSimConsoleClient

2022-12-26T17:26:51Z

Ferd Frederix: Missing = sign

{{Quicklinks}}

OpenSimConsoleClient von Melanie Thilker

Download:

Windows: http://opensimulator.org/downloads/ConsoleClient.zip

Mac: http://opensimulator.org/downloads/ConsoleClient.dmg

OpenSim.ini Konfigurationsdatei öffnen und unter abschnitt Network Wunschname und Wunschpasswort eingeben, dabei merken sie sich die unter http_listener_port angegebene Nummer.

[Network]
ConsoleUser = "Wunschname"
ConsolePass = "Wunschpasswort"
console_port = 0
http_listener_port = 9000

Der OpenSimulator muss nun mit der Option „OpenSim.exe -console rest“ gestartet werden.

Linux mit screen:
screen -fa -S OS -d -U -m mono OpenSim.exe -console=rest

ConsoleClient.zip entpacken und dann ConsoleClient.exe starten.

Oben unter Connection New auswählen:

Connection > Hier einen Namen der zu der Serververbindung passt eingeben.

Host > Hier die URL zum Server eingeben 192.16.8.1.100 oder meinserver.de je nachdem halt.

Port > Den gemerkten Port hier eingeben.

User > Wunschname den man sich ausgesucht hat hier eingeben.

Passwort > Hier das Wunschpasswort eingeben welches man sich ausgesucht hat.

Mit dem anklicken von OK wird das gespeichert und auf der rechten Seite angezeigt.

Im gleichen Schema kann man seine ganzen Server eintragen.

Jetzt klickt man auf einen der auf der rechten Seite aufgelisteten Server wähle oben Connection und Connect schon ist man auf dem Server in der Konsole.

Vorteile der neuen Konsole: man kann mal eben in wenigen Sekunden in die Konsole und Commands eingeben ohne erst umständlich Verbindung zum Server aufzubauen sich mit dem screen Kommando herumärgern.

Nachteil das ganze Programm arbeitet noch nicht richtig obwohl es schon durchaus brauchbar ist.

Useful Queries

2022-10-21T02:50:21Z

Ferd Frederix: /* Error Checking */ add grid version of inv check

__NOTOC__
{{Quicklinks}}
<br />

This page lists various SQL queries one can perform from a MySql console to check the database for various bits of information. They have not been tested in other SQL variants, and may or may not work as intended:

'''NOTE: In SVN revision 5115 through 5123, some UUID fields began migrating to a consistent format (the dashed form, like 00000000-0000-0000-0000-000000000000).'''

'''This means that in these later revision databases, you will no longer need to use the hex(id) function on the assets table. On the other hand, until all UUIDs are in the same format, replace(id, '-', <nowiki>''</nowiki>) will still be necessary on dashed UUID fields to get the id's into a consistent format for joins and such. UUID literals inserted into queries should not have dashes. The queries on this page have not yet been revised to take this into consideration.'''

== Listing things ==

* List All Friends of a Certain User, this checks one column and then checks the other, it will not Show Flags, so even if it is still just "Offered" then it will show as a friend.
<nowiki>SELECT friends.PrincipalID, CONCAT(useraccounts.FirstName, " ", useraccounts.LastName) AS "Friend" FROM friends,useraccounts WHERE
friends.Friend = "054f4add-305d-48f3-a998-c5db4c8e15c9" AND useraccounts.PrincipalID = friends.PrincipalID
UNION
SELECT friends.Friend, CONCAT(useraccounts.FirstName, " ", useraccounts.LastName) AS "Friend" FROM friends, useraccounts WHERE friends.PrincipalID =
"054f4add-305d-48f3-a998-c5db4c8e15c9" AND useraccounts.PrincipalID = friends.Friend</nowiki>

* List the users presently logged in (may be inflated due to users not getting logged out properly, whether due to bugs or crashes):

<nowiki> SELECT concat(FirstName, ' ', LastName) AS 'Online Users' FROM UserAccounts INNER JOIN GridUser ON UserAccounts.PrincipalID = GridUser.UserID WHERE GridUser.Online = 'True';</nowiki>
* List the Regions in your database (only works for grid mode):
<nowiki>SELECT regionName as 'Regions' FROM regions;</nowiki>

* Find the asset UUID of a given inventory Item (replace the name with the one you want). This may return multiple rows if more than one inventory item exists, and some entries may point to a single asset, while others point at different assets.
<nowiki>SELECT inventoryName, InventoryID, assetID FROM inventoryitems WHERE inventoryName = 'My Inventory Item Name Here';</nowiki>

* Verify a particular asset exists, given the UUID (usually you want to replace the UUID here with an assetID from the previous query):
<nowiki>SELECT name FROM assets WHERE id = replace('ef9c5edf-a9f8-4310-8048-97894453a614', '-', '');</nowiki>

* More complicated version - List inventory entries with a particular name:
<nowiki>SELECT concat(inventoryName, ' - ', replace(inventoryID, '-', '')) AS 'Inventory',
concat(assets.name, ' - ', hex(assets.id)) AS 'Asset' FROM inventoryitems LEFT JOIN assets
ON replace(assetID, '-', '')=hex(assets.id) WHERE inventoryName = 'My Inventory Item Here';</nowiki>

Given 'I can haz asset' as a name, and assuming several users had something called that in their inventories, this might return:
+----------------------------------------------------+--------------------------------------------------------+
| Inventory | Asset |
+----------------------------------------------------+--------------------------------------------------------+
| I can haz asset - 17b6ca75ca8444a1813718705c591be6 | Cheeseburger - 12345678123456781234567812345678 |
| I can haz asset - 94ac2e6a26f74e03bedeff0e5747819a | lolcat in ur assets - 13371337133713371337133713371337 |
| I can haz asset - 96a6dd77c3ec4ebf91ab7e182ebb7b41 | lolcat in ur assets - 13371337133713371337133713371337 |
+----------------------------------------------------+--------------------------------------------------------+
3 rows in set (0.00 sec)

The last two entries are the same asset, but two different inventory entries. If you get a NULL result in the Asset column, that means the asset was not found (see the error checking section)

Or, alternately, list all inventory items by asset name:
<nowiki>SELECT concat(inventoryName, ' - ', replace(inventoryID, '-', '')) AS 'Inventory',
concat(assets.name, ' - ', hex(assets.id)) AS 'Asset' FROM opensim.inventoryitems INNER JOIN opensim.assets
ON replace(assetID, '-', '')=hex(opensim.assets.id) WHERE opensim.assets.name = 'My Asset Name Here';</nowiki>

Which (given 'lolcat in ur assets' as the name) might return:
+----------------------------------------------------+--------------------------------------------------------+
| Inventory | Asset |
+----------------------------------------------------+--------------------------------------------------------+
| Pretty Pikshurs - 7962c8de232042ce845c40653ca31a0a | lolcat in ur assets - 13371337133713371337133713371337 |
| I can haz asset - 96a6dd77c3ec4ebf91ab7e182ebb7b41 | lolcat in ur assets - 13371337133713371337133713371337 |
+----------------------------------------------------+--------------------------------------------------------+
2 rows in set (0.00 sec)

== Counting things ==

* Count the total number of users:

<nowiki>SELECT count(uuid) AS 'Users' FROM opensim.users;</nowiki>

* Count the number of users presently logged in (same issues as listing online users, above):

<nowiki>SELECT count(UUID) AS 'Users Online' FROM opensim.agents WHERE agentonline = '1';</nowiki>

* Count the number of Regions. There are different versions, depending on whether you run in standalone or grid mode, because standalone mode lacks the regions table.

* Count the regions that have parcels:
<nowiki>SELECT count(DISTINCT regionUUID) FROM opensim.land;</nowiki>

* Count the total number of parcels:
<nowiki>SELECT count(UUID) AS 'Parcels' FROM opensim.land;</nowiki>

=== Standalone mode ===
This may be slow if you have a lot of old terraforming revisions lying around your database:
<nowiki>SELECT count(DISTINCT regionUUID) AS 'Regions' FROM opensim.terrain;</nowiki>

=== Grid Mode ===

Version 1 counts unique Region names:
<nowiki>SELECT count(DISTINCT regionName) AS 'Regions' FROM opensim.regions;</nowiki>

Version 2 counts regionIDs, so if you have multiple entries for regions, this will catch them.
<nowiki>SELECT count(UUID) AS 'Regions' FROM opensim.regions;</nowiki>

== Error Checking ==
* List all inventory entries that point to assets that do not exist (this should never happen, but if there are items in your inventory that you can't seem to use something and/or the asset server complains about an asset missing, see if it turns up with):
<nowiki>SELECT inventoryname, inventoryID, assetID FROM opensim.inventoryitems WHERE replace(assetID, '-', '')
NOT IN (SELECT hex(id) FROM opensim.assets);</nowiki>

* Check if there's leftover primshapes without a entry in the prim table and delete them - standalone

<nowiki>delete from primshapes using primshapes left join prims on prims.uuid=primshapes.uuid where prims.uuid is null; </nowiki>

* Check if there's leftover primshapes without a entry in the prim table and delete them - grid

<nowiki>select * from primshapes left join prims on prims.uuid=primshapes.uuid where prims.uuid is null</nowiki>

OsTeleportAgent

2022-07-16T16:30:44Z

Ferd Frederix: Minor edit to script to use CHANGED_REGION_START instead of 256

{{osslfunc
|threat_level=Severe
|permissions=${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER
|delay=0.5
|additional_info=
'''osTeleportAgent''' has a 0.5 second delay if the teleport is not allowed, or when the destination is to a location in the same region as the Agents current region. A teleport to other region has a 5 second delay<br>
For teleports within region, in particular NPC agents, consider using [[osLocalTeleportAgent]]
|function_syntax= osTeleportAgent(key agent, string regionName, vector position, vector lookat)<br />
osTeleportAgent(key agent, integer regionX, integer regionY, vector position, vector lookat)<br />
osTeleportAgent(key agent, vector position, vector lookat)
|ossl_example=<source lang="lsl">
// Example osTeleportAgent Script
//
// Set Destination as described below, There are a Few Options depending on Application:
// IN GRID Teleport
// Destination = "1000,1000"; = Using In-Grid Map XXXX,YYYY coordinates
// Destination = "RegionName"; = Using RegionName
// HyperGrid Teleport (region must be HG Enabled)
// Destination = "TcpIpAddr:Port:RegionName"; = Using the Target/Destination IP Address
// Destination = "DNSname:Port:RegionName"; = Using the Target/Detination DNSname
// Note: RegionName is Optionally Specified to deliver Avatar to specific region in an instance.
//
// ========================================================================================
// === SET DESTINATION INFO HERE ===
//
string Destination = "LBSA Plaza"; // your target destination here (SEE NEXT LINES) Can Be
vector LandingPoint = <128.0, 128.0, 50.0>; // X,Y,Z landing point for avatar to arrive at
vector LookAt = <0.0, 1.0, 0.0>; // which way they look at when arriving
//
default
{
on_rez(integer start_param)
{
llResetScript();
}
changed(integer change) // something changed, take action
{
if(change & CHANGED_OWNER)
llResetScript();
else if (change & CHANGED_REGION_START) // that bit is set during a region restart
llResetScript();
}
state_entry()
{
llWhisper(0, "OS Teleportal Active");
}
touch_start(integer num_detected)
{
key avatar = llDetectedKey(0);
llRegionSayTo(avatar, 0,"Teleporting you to : "+Destination);
osTeleportAgent(avatar, Destination, LandingPoint, LookAt);
}
}
</source>
<source lang="lsl">
//
// Example teleport to region at west, 10m from the border to current and facing west
//
default
{
state_entry()
{
llOwnerSay("OS Teleportal Active");
}
touch_start(integer num_detected)
{
key avatar = llDetectedKey(0);
vector pos = llGetPos();
llRegionSayTo(avatar, 0, "Teleporting you there");
osTeleportAgent(avatar, <-10, pos.y, pos.z + 1>,<-1,0,0>);
}
}</source>
|description=Teleports an agent to the specified location<br>
* position is the location relative to destination region reference corner<br>
* lookAt is the direction the avatar should look. Z value is ignored. For example to face north use <0,1,0><br>

The first variant is able to teleport to any addressable region, including [[hypergrid]] destinations.

The second variant teleports to a region in the local grid; the region coordinates are specified as region cells (not as global coordinates based on meters).

The third variant teleports within the current region. Since version 0.9.2.0 it can also teleport to a nearby region if position does point to one

For osTeleportAgent() to work, the owner of the prim containing the script must be the same as the parcel that the avatar is currently on.

If this isn't the case then the function fails silently.

See also [[osTeleportOwner]], and if you receive an error see [[OSSL Enabling Functions|how to enable OS functions]].
|
}}

Hypergrid

2021-12-24T19:53:07Z

Ferd Frederix: /* Teleporting via the Hypergrid */ Fix link syntax. We don't use http

{{Quicklinks}}
<br />

= What is the hypergrid? =


The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds.

The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.

The hypergrid started as a external project, but it is now included in the standard distribution of OpenSimulator. '''To run your OpenSimulator instance in hypergrid mode, please see [[Installing and Running Hypergrid]].'''

= Hypergrid Versions =
* [[Hypergrid 2.0]] - current Hypergrid with greater security controls for region operators
* [[Hypergrid 1.5]] - past Hypergrid version with greater asset security and expanded services
* [[Hypergrid 1.0]] - the original Hypergrid described below

= Teleporting via the Hypergrid =
The structure of a hypergrid link is similar to a web page link : [hop://]<hg-host>:<hg-port>[/<region-name>][/x/y]. Examples:

"hop://cc.opensimulator.org:8002/keynote 1"
"hop://grid.mydomain.com:9000"

The first example is the Hypergrid address of a region named "keynote 1" on the grid at cc.opensimulator.org that has port 8002.

The second example gives only the hg-host and port. In this case, the destination region is the default region setup for that grid, as specified in the [GridService] section of bin/Robust.HG.ini (for grid) or bin/config-include/StandaloneCommon.ini (for standalones).

= Installing and Running =

Please see [[Installing and Running Hypergrid]].

= Hypergrid Concepts =

* [[Hypergrid Concepts]].
* [[Hypergrid Glossary]].

= Hypergrid Development =
See [[Hypergrid Protocol]] for protocol level details.

See [[Hypergrid Implementation]] for implementation details.

= Hypergrid Parameters =

For information about each Hypergrid configuration parameter and what it does, please see [[Hypergrid Parameters]] (eventually).

= Hypergrid Security =

Please see [[Hypergrid Security]].

= Hypergrid Friends =

* [[Hypergrid Friends]] (updated 2015)
* [[Hypergrid_Friends_and_IM]] (updated 2011)

= Public Hypergrid Nodes =

Please see [[Public Hypergrid Nodes]].

= Hypergrid Lists =
Please see [[Hypergrid Lists]].

= Further References =
* [http://www.ics.uci.edu/~lopes/opensim/HypergridReferenceGuide.html The Hypergrid Reference Guide]
* [https://web.archive.org/web/20150426153421/https://dl.dropboxusercontent.com/u/18483217/hypergrid-draft.pdf Hypergrid: Architecture and Protocol for Virtual World Interoperability] - Cristina Videira Lopes paper defining Hypergrid protocol (PDF format)

= Development Meetings =

[[Hypergrid Meetings]]

[[Category:Hypergrid]]

= See Also =
Also see [[Grider]]; [[Virtual World Model]]; [[HyperGrid Team]]

NAT Loopback Routers

2021-12-12T20:50:08Z

Ferd Frederix: /* Router / Modem Table */ add cisco DPC3848VM

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

If solving the problem by configuring your router turns out not to be possible, you can work around it by setting up some IPTable rules on the computer you're using to browse the web (assuming it's a GNU/Linux OS). For details see the NAT Loopback [[Iptables-script]].

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || TM1602G || Not Working || Arris Touchstone from Spectrum
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Cisco || [https://www.cogeco.ca/sites/default/files/guides/cisco_wireless_residential_gateway_model_DPC3848_DPC3848V_DPC3848VM_DOCSIS_3_0.pdf DPC3848VM] || No Loopback ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
|Netgear || Nighthawk Pro Gaming XR700 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX80/ RAX75 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX50/ RAX45 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX40/ RAX35 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX20/ RAX15 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX200 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RS400 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R9000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7960P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7500v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7300DST ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7200/ R7350/ R7400/ R7450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900V1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7100LG ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v3 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6300v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6260/R6330/ R6350/ R6850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6250 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6220/ R6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6080 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6050/JR6150 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6020 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR750 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR40 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR20 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR10 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C3700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6220 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7100V ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Tp-Link || AX1500 Wifi 6 || Not Working || TCP does loop back, but not UDP between regions. Works if you add one entry per port, (no 8004-8100) but its limited in the number of entries. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/] Cable Router
|-
| Ubee || DVW32CB || Works || [http://www.ubeeinteractive.com/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

[[NAT_Loopback|Windows 10 NAT Loopback notes]]

External links:

* [http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html Windows XP NAT Loopback]

* [http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/|Windows 7 NAT Loopback]

* [https://www.youtube.com/watch?v=yIrDvVjyiMk|Windows 8, 8.1, 10 NAT Loopback]

[[Category:Hardware]]

See also: [[Network_Settings#DynDNS_loopback|Using DynDNS for NAT Loopback with Windows, MacOS, or Linux]]

NAT Loopback Routers

2021-07-21T01:12:41Z

Ferd Frederix: /* Router / Modem Table */ Add UBEE DVW32CB

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

If solving the problem by configuring your router turns out not to be possible, you can work around it by setting up some IPTable rules on the computer you're using to browse the web (assuming it's a GNU/Linux OS). For details see the NAT Loopback [[Iptables-script]].

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || TM1602G || Not Working || Arris Touchstone from Spectrum
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
|Netgear || Nighthawk Pro Gaming XR700 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX80/ RAX75 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX50/ RAX45 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX40/ RAX35 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX20/ RAX15 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX200 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RS400 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R9000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7960P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7500v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7300DST ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7200/ R7350/ R7400/ R7450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900V1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7100LG ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v3 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6300v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6260/R6330/ R6350/ R6850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6250 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6220/ R6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6080 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6050/JR6150 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6020 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR750 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR40 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR20 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR10 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C3700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6220 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7100V ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Tp-Link || AX1500 Wifi 6 || Not Working || TCP does loop back, but not UDP between regions. Works if you add one entry per port, (no 8004-8100) but its limited in the number of entries. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/] Cable Router
|-
| Ubee || DVW32CB || Works || [http://www.ubeeinteractive.com/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

[[NAT_Loopback|Windows 10 NAT Loopback notes]]

External links:

* [http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html Windows XP NAT Loopback]

* [http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/|Windows 7 NAT Loopback]

* [https://www.youtube.com/watch?v=yIrDvVjyiMk|Windows 8, 8.1, 10 NAT Loopback]

[[Category:Hardware]]

See also: [[Network_Settings#DynDNS_loopback|Using DynDNS for NAT Loopback with Windows, MacOS, or Linux]]

Grid List/Outworldz

2021-04-30T18:34:32Z

Ferd Frederix: Create Outwworldz Grid_list Page

__NOTOC__
{{Quicklinks}}

{|border="1" cellpadding="5" cellspacing="0"
| Name:
| Outworldz.com
|-
| Website:
| [http://www.outworldz.com|http://www.outworldz.com]
|-
| Login URI:
| <nowiki>-loginuri http://www.outworldz.com:8002</nowiki> 
|-
| Wiki/Forum:
| [https://mewe.com/join/opensimulator_dreamworld_and_dreamgrid|https://mewe.com/join/opensimulator_dreamworld_and_dreamgrid]
|-
| Approx # Regions
| 170
|-
| Approx # Users
| 850
|-
| Logins/month
| 165
|}

Outworldz.com is the home of DreamGrid, the one-click Opensim for Windows, Outworldz.net, and Inworldz.net
[[Category:Grids]]

Grid List

2021-04-30T18:28:49Z

Ferd Frederix: /* Public grids */

__NOTOC__
{{Quicklinks}}

== What is the Grid List? ==
There are hundreds (thousands?) of OpenSimulator-based virtual worlds out there. Many of them are free to use and welcome new users. This grid list is a community-generated list of such worlds. If you would like to experience an OpenSimulator-based virtual world before installing your own, try one of these.

'''IMPORTANT NOTE:''' The OpenSimulator project is not responsible for, nor in any way associated with, any grid listed on this page, nor for any grid's content or activities. Visit at your own risk. Also, there are no guarantees that these worlds are up and running.

== Public grids ==

'''Grid List Policy:''' Please list your grid only if uses OpenSimulator as a component. Do not include advertising language. The entries in the main list should just contain the grid name and the plain numbers as defined by the column headers. '''Please use [[Grid List/Template|this template]] for the subpages to keep the information in a comparable manner.''' Grids are listed in the order of appearance, so please add your entry to the bottom of the list. Anyone found inserting a grid up higher in the list will have their entry moved or removed.

You may want provide a link on your world's website back to the project by using the [[OpenSim Graphics|Powered by OpenSimulator logo]].<br>

'''Note:''' This is only a partial listing of grids. Hypergrid Business maintains a list of active grids, updated monthly: [http://www.hypergridbusiness.com/statistics/active-grids/ Active OpenSimulator grids]
<br /><br />Grid Page last updated on Sep 13 2020<br /><br />

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
! Grid Name
! # Regions
! Approx # Users
! Unique last 30days
|-
| [[Grid List/OSGrid|OSGrid]]
| 4665
| 125000
| 4380
|-
| [[Grid List/Francogrid|FrancoGrid]]
| 298
| 5593
| 298
|-
| [[Grid List/3rd Rock Grid|3rd Rock Grid]]
| 283
| 11765
| 347
|-
| [[Grid List/Metropolis|Metropolis Metaversum]]
| 1581
| 14706
| 3579
|-
| [[Grid List/Open-Neuland|OpenSimulator-Club - Open Neuland]]
| 216
| 384
| 60
|-
| [[Grid List/Wilder-Westen|OpenSimulator-Club - Wilder Westen]]
| 41
| 122
| 36
|-
| [[Grid List/Myopengrid.com|MyOpenGrid]]
|  
|  
|  
|-
| [[Grid List/Your Alternative Life|Your Alternative Life]]
| 47
| 2089
| 1458
|-
| [[Grid List/Openvue|Openvue]]
| 16
| 24
| 64
|-
| [[Grid List/Logicamp|Logicamp - Outdoor Grid]]
| 179
| 3300
| 577
|-
| [[Grid List/Jamgrid|Jamgrid]]
| 15
| 55
| 15
|-
| [[Grid List/JOGrid|Japan Open Grid]]
| 158
| 682
| 142
|-
| [[Grid List/Tlön|Tlön]]
| 11
| 65
| 10
|-
| [[Grid List/PMGrid|PMGrid]]
| 80
| 100
| 10
|-
| [[Grid List/jokaydiagrid|jokaydiaGRID]]
| 20
| 253
| 75
|-
| [[Grid List/Craft-World|Craft-World]]
| 207
| 9429
| 607
|-
| [[Grid List/Virtual RP|Virtual RP]]
| 17
| 714
| 55
|-
| [[Grid List/GerGrid|GerGrid]]
| 98
| 408
| 25
|-
| [[Grid List/AnSky|AnSky]]
| 14
| 106
| 6
|-
| [[Grid List/Virtual Worlds Grid|Virtual Worlds Grid]]
| 527
| 30
| 4
|-
| [[Grid List/3DGrid World|3DGrid World (formerly The SecondLearning Grid)]]
| 4
| 55
| 46
|-
| [[Grid List/Sofitek|Sofitek]]
| 8
| 21
| 21
|-
| [[Grid List/Dorenas World|Dorenas World]]
| 143
| 448
| 300
|-
| [[Grid List/Speculoos|Speculoos]]
| 30
| 50
| 35
|-
| [[Grid List/Pathlandia|Pathlandia]]
| 4
| 1
| 30
|-
| [[Grid List/Austria|Austria]]
| 11
| 6
| 9
|-
| [[Grid List/Psychedelia|Psychedelia]]
| 7
| 7
| 11
|-
| [[Grid List/M001|M001]]
| 10
| 4
| 4
|-
| [[Grid List/HyperGrid Plaza|HyperGrid Plaza]]
| 1
| 100
| 10
|-
| [http://adreans-world.from-fl.com/home/ Adreans-World]
| 147
| 518
| 43
|-
|[http://www.jopensim.com jOpenSimWorld]
| 39
| 327
| 39
|-
|[[Grid List/RevWorld|Rev World]]
| 56
| 1461
| 256
|-
|[[Grid List/Littlefield_Grid|Littlefield Grid]]
| 351
| 2078
| 383
|-
| [[Grid List/Alife Virtual|Alife Virtual]]
| 500
| 10000
| 1000
|-
|[[Grid List/Athabasca University|Athabasca University]]
| 16
| 15 (in development stage)
| 15
|-
| [[Grid_List/IgnisFatuus|Ignis Fatuus]]
| 47
| 14
| 72
|-
| [[Grid List/DigiWorldz|DigiWorldz]]
| 6907
| 8582
| 2315
|-
| [[Grid List/gimisaOS|gimisaOS]]
| 10
| 1
| 30
|-
| [[Grid List/DSGrid|DSGrid]]
| 17
| 52
| 71
|-
| [[Grid List/Regno di Camlaan|Regno di Camlaan]]
| 8
| 19
| 60
|-
| [http://partydestinationgrid.com Party Destination Grid]
| 120
| 1500
| 1050
|-
| [[Grid_List/pathway_universe|pathway universe]]
| 26
| 60
| 2
|-
| [[Grid_List/Neverworld_Grid|Neverworld Grid ]]
| 328
| 1221
| 383
|-
|[[Grid List/Zone Nations|Zone Nations®]]
| 31
| 6107
| 3678
|-
|[http://www.vibel.eu Vibel]
| 15
| 839
| 839
|-
| [[Grid List/Anetteswelt|Anetteswelt]]
| 143
| 5
| 5
|-
| [[Grid List/openmanniland|openmanniland - OpenSim 0.9.2.0, oswp Webinterface and DTL/NSL MoneyServer]]
| 10
| 5
| 5
|-
| [[Grid List/ReactionGrid|ReactionGrid]]
| 76
| 9756
| 406
|-
| [[Grid List/GorGrid|GorGrid]]
| 10
| 31
| 58
|-
| [[Grid List/Outworldz|www.Outworldz.com and DreamGrid Home]]
| 170
| 826
| 161
|}

<br/>

== Inactive Public grids ==

{{ambox
| type = inactive
| text = This is a list of Grids that been inactive for a few days and or have claimed to be inactive by the owner. [[Category:Grid List]]
}}

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" valign="bottom"
! Grid Name
! # Regions
! Approx # Users
! Unique last 30days
|-
| [[Grid List/Cybergrid|Cybergrid]]
| 1
| 44
|  
|-
| [[Grid List/MOSES|MOSES: Military Open Simulator Enterprise Strategy]]
| 117
| 227
| 102
|-
| [[Grid_List/SirinHGpole-Grid|SirinHGpole-Grid]] (regions merged into OSGrid)
| 238
| 120
| 70
|-
| [[Grid List/The New World Grid|The New World Grid]]
| 330
| 5200
| 590
|-
| [[Grid List/Uvatar|Uvatar]]
|  ???
|  ???
| 0 
|-
| [[Grid List/Cyberlandia|Cyberlandia]]
| 185
| 1600
| 269
|-
|[[Grid List/CloneLife|Clone Life]]
| 31
| 6107
| 3678
|-
| [http://www.goreanlifestyle.com/ Gorean Life Style]
|30
|50
|45
|-
| [[Grid List/COSIE Grid|COSIE Grid]]
| 6
| 3
| 3
|-
| [[Grid List/H omeland3D|Homeland3D]]
| 40
| 4
| 4
|-
| [http://www.meetinstantly.com/ MeetInstantly]
| 32
| 5
| 5
|-
|[[Grid List/Traduverse|Traduverse]]
| 49
| 27
| 27
|-
| [[Grid List/Regno di Camlaan|Regno di Camlaan]]
| 8
| 19
| 60
|-
| [[Grid List/AndromedaGrid|Andromeda Grid]]
| 10
| 4
| 0
|-
| [[Grid List/EduGrid|EduGrid]]
| 15
| 2000
| 50
|-
|[https://web.archive.org/web/20110602161855/http://virtualhighway.us:80/ Virtual Highway]
| 706
| 6318
| 285
|-
| [[Grid List/Ice Grid|Ice Grid]]
| 40
| 32
| 5
|-
| [[Grid List/ART|ART]]
| 3(real)
| ? (real)
| 150(real)
|-
| [[Grid List/Stone Grid|Stone Grid]]
| 3
| 4
| 4
|-
| [[Grid List/LifeStyle3D - ItalianGrid|LifeStyle3D - ItalianGrid]]
| 32
| 350
| 108
|-
| [[Grid List/My3dLife|My3DLife]]
| 10
| 20
| 3
|-
| [[Grid List/DaseinWorld|DaseinWorld]]
| 16
| 3
| 3
|-
| [[Grid List/OpenSim Creations Grid|OpenSim Creations Grid]]
| 15
| 11
| 10
|-
| [[Grid List/StarGates Matrix|StarGates Matrix]]
| 5
| 7
| 3
|-
| [[Grid List/You3D|You3D]]
| 11
| 6
| 6
|-
| [[Grid List/Virtual Realms Grid|Virtual Realms Grid]]
| 8
| 10
| 3
|-
| [[Grid List/Gor Grid|Gor Grid]]
| 8
| 10
| 10
|-
| [[Grid List/Enakai|Enakai]]
| 16
| 14
| 34
|-
| [[Grid List/Greeklife|GreekLife]]
| 30
| 50
| 35
|-
| [[Grid List/EverWorlds.com|EverWorlds: Bringing People Together (formerly Destiny Zero)]]
| 17
| 2
| 3
|-
| [[Grid List/IcaruSRealmS|=IcaruS= RealmS]]
| 26
|  
| 14
|-
| [[Grid List/lpgrid.com|Lost Paradise]]
| 2847
| 820
| 670
|-
| [[Grid List/Valhalla Virtual|Valhalla Virtual]]
| 9
| 25
| 4
|-
| [[Grid List/Cyber Wrld|Cyber Wrld]]
| 5
| 8
| 8
|-
| [[Grid List/FleepGrid|FleepGrid]]
| 11
| 150
|
|-
| [[Grid List/Lisat|ArtGridOnLine]]
| 12
| 48
| 15
|-
| [[Grid List/EU-Grid|EU-Grid]]
| 10
| 350
|  
|-
| [[Grid List/GiantGrid|GiantGrid]]
| 169
| 261
| 157
|-
| [[Grid List/pseudospace|Pseudospace]]
| 12
| 46
|  
|-
| [[Grid List/Metapocalypse|Metapocalypse Grid]]
|  
|  
|  
|-
| [[Grid List/UFSGrid|UFSGrid]]
| 36
| 897
| +/-50
|-
| [[Grid List/Unica|Unica]]
| 16
| 60
| 10
|-
| [[Grid List/LISAT|Lost-in-Space-and-Time]]
|  
|  
|  
|-
| [[Grid List/Rezzable Visions|Rezzable Visions]]
|  
|  
|  
|-
| [[Grid List/SimValley NL|SimValley NL]]
| 1087
| 364
| 32
|-
| [[Grid List/Your2Live|Your2Live]]
| 3
| 8
| *
|-
| [[Grid List/OPENSIM NL|OpenSim NL]]
| 9
| 426
| 34
|-
| [[Grid List/VirtualFrance3D|VirtualFrance3D]]
| 16
| 143
| 31
|-
| [[Grid List/Twisted Sky|Twisted Sky]]
| 60
| 290
| 68
|-
| [[Grid List/REDISIS|redOasis (formerly RedIsis)]]
| 130
| 60
| 20
|-
| [[Grid List/PearGrid|PearGrid]]
| 18
| 34
| 8
|-
| [[Grid List/Island Oasis|Island Oasis]]
| 212
| 9107
| 860
|-
| [[Grid List/HAVEN: Your World|HAVEN: Your World]]
| 13
| 11
| 7
|-
| [[Grid List/Flatlandia.cc|Flatlandia]]
| 33
| 177
| 110
|-
| [[Grid List/TertiaryGrid|Tertiary Grid]]
| 41
| 379
| 42
|-
| [[Grid List/Annuna Grid|Annuna Grid]]
| 60
| 60
|  
|-
| [[Grid List/VeeSome|VeeSome]]
| 48
| 106
| 53
|-
| [[Grid List/VirtuaLife|Virtualife]]
| 132
| 1000
| 500
|-
| [[Grid List/Avatar Hangout|Avatar Hangout (with OMC)]]
| 73
| 8,626
| 58
|-
| [[Grid List/DGP Grid|DGP Grid]]
|  
|  
|  
|-

| [[Grid List/tescos.org.uk|tescos.org.uk (curency ƒ)]]
| 30
| 20
| 20
|-
| [[Grid List/Role Play Worlds|Role Play Worlds - Your Fantasy, your world]]
| 129
| 2276
| 298
|-
| [[Grid List/Avatrian|Avatrian]]
| 11
| 25
| 150
|-
| [[Grid List/OSBEST|OSBEST]]
| 12
| 8
| 8
|-
| [[Grid List/MCM Realm|MCM Realm]]
| 22
| 73
| 23
|-
| [[Grid List/Oasis Grid|Oasis Grid]]
| 89
| 3068
| 228
|-
| [[Grid List/AtMeeting|AtMeeting Grid]]
| 20
| 30
| 25
|-
| [[Grid List/OpenUtopia|OpenUtopia Grid]]
| 1
| 3
| 3
|-
| [[Grid List/Virtualgames3d|Virtualgames3d]]
| 140
| 1350
| 500
|-
| [[Grid List/Grid4Us|Grid4Us]]
| 22
| 130
| 50
|-
| [[Grid List/K-grid|K-grid]]
|  
|  
|  
|-
| [[Grid List/Le Monde de Darwin|Le Monde de Darwin]]
| 73
| 83
| 36
|-
| [[Grid List/NeXtLife|NeXtLife Grid]]
| 15
| 7
| 7
|-
| [[Grid List/Sensation Games|Sensation Games]]
| 1
| 2
| 1
|-
| [[Grid List/SLI-Grid|SLI-Grid]]
| 5
|  
|  
|-
| TGGrid
| 11
| 9
| 13
|-
| [[Grid List/4AllGrid|4AllGrid]]
| 68
| 6
| 23
|-
| [[Grid List/AlphaTowne|Alpha Towne]]
| 308
| 1172
| 909
|-
| [[Grid_List/AstralGrid|AstralGrid]]
| 70
| 40
| 30
|-
| [[Grid_List/Avination|Avination]]
| 110
| 300
| 20
|-
| [[Grid_List/EduverseGrid|EduverseGrid]]
| 147
| 400
| Data Unknown
|-
| [[Grid List/German Grid|German Grid]]
| 107
| 2353
| 385
|-
| [[Grid List/Heritage Key|Heritage Key]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/ccdbbs.com|LPgrid]]
| 345
| 331
| 0
|-
| [[NewtonGrid]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/RPGRID_NL|RPGRID NL]]
| 30
| 141
| 16
|-
| [[Grid List/ScienceSim|ScienceSim]]
| 25
| 30
| 15
|-
| [[Grid_List/SkyLifeGrid|SkyLifeGrid]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/slitalia|Slitalia]]
| 7
| 10
| n/a
|-
| [[Grid_List/SunlightGrid|SunlightGrid]]
| 167
| 503
| n/a
|-
| [[Grid_List/Taekwondoverse|Taekwondoverse]]
| 162
| 400
| Data Unknown
|-
| [[Grid_List/Virtual_Life|Virtual Life]]
| 34
| 1004
| n/a
|-
| [[Grid_List/VirtuLife|VirtuLife]]
| 21
| 10
| n/a
|-
| [[Grid List/virtyou|virtyou]]
| 110
| 1676
| 70
|-
| [[Grid_List/World4US|World4US]]
| 25
| 37
| n/a
|-
| [[Grid List/digsynth.com|World of the Free]]
| 0
| 0
| 0
|-
| [[Grid_List/YrGrid|YrGrid]]
| 33
| 2150
| n/a
|-
| [[Grid List/Zairus Grid|Zairus Grid]]
| 72
| 10
| 3

|}

== Office Hour ==

Each week on Tuesday, OSGrid hosts an official Office Hour where the OpenSimulator developers meet and discuss the weeks software development activities. This is a good place to get to know what is going on with OpenSimulator.

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
!Grid
!Region
!Time
|-
|[http://osgrid.org/ OSGrid]
|Wright Plaza
|Tuesday 11:00AM Pacific Time (USA)
|-
|[http://logicamp.org/ logicamp MainGrid]
|Logicamp
|Friday 11:00 - 12:00 GMT+1
|-
|[http://www.lfgrid.com Littlefield Grid]
|Monthly Grid Status Meeting - Smithville Region - lfgrid.com:8002:smithville
|First Friday of the Month 1:30PM PSD
|-
|[http://www.hypergrid.org Metropolis Metaversum]
|Weekly "Stammtisch" Meeting on Region *CenterWorld*
|Every Wednesday 21:00 - 22:00 <br>(GMT/UTC + 1)
|}

== Grid Test Hours ==

Several grids provide valuable testing information for the project, each run a special 'test' hour to test capabilities of the platform. These are run at the same time every week. It may also be a good chance to meet people who can answer questions you may have.

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
!Grid
!Region
!Time
|-
|[http://francogrid.org/ FrancoGrid]
|Orion
|Everydays 2100GMT+1
|-
|[http://logicamp.org/ Logicamp]
|Logicamp
|Generally Mondays 0900 GMT+1
|}

= See Also =

* [[Grid Associations]]
* [[Public Hypergrid Nodes|HyperGrid Nodes]]

[[Category:Grids]]

Grid List

2021-04-30T18:27:06Z

Ferd Frederix: /* Public grids */ Add outworldz at bottom

__NOTOC__
{{Quicklinks}}

== What is the Grid List? ==
There are hundreds (thousands?) of OpenSimulator-based virtual worlds out there. Many of them are free to use and welcome new users. This grid list is a community-generated list of such worlds. If you would like to experience an OpenSimulator-based virtual world before installing your own, try one of these.

'''IMPORTANT NOTE:''' The OpenSimulator project is not responsible for, nor in any way associated with, any grid listed on this page, nor for any grid's content or activities. Visit at your own risk. Also, there are no guarantees that these worlds are up and running.

== Public grids ==

'''Grid List Policy:''' Please list your grid only if uses OpenSimulator as a component. Do not include advertising language. The entries in the main list should just contain the grid name and the plain numbers as defined by the column headers. '''Please use [[Grid List/Template|this template]] for the subpages to keep the information in a comparable manner.''' Grids are listed in the order of appearance, so please add your entry to the bottom of the list. Anyone found inserting a grid up higher in the list will have their entry moved or removed.

You may want provide a link on your world's website back to the project by using the [[OpenSim Graphics|Powered by OpenSimulator logo]].<br>

'''Note:''' This is only a partial listing of grids. Hypergrid Business maintains a list of active grids, updated monthly: [http://www.hypergridbusiness.com/statistics/active-grids/ Active OpenSimulator grids]
<br /><br />Grid Page last updated on Sep 13 2020<br /><br />

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
! Grid Name
! # Regions
! Approx # Users
! Unique last 30days
|-
| [[Grid List/OSGrid|OSGrid]]
| 4665
| 125000
| 4380
|-
| [[Grid List/Francogrid|FrancoGrid]]
| 298
| 5593
| 298
|-
| [[Grid List/3rd Rock Grid|3rd Rock Grid]]
| 283
| 11765
| 347
|-
| [[Grid List/Metropolis|Metropolis Metaversum]]
| 1581
| 14706
| 3579
|-
| [[Grid List/Open-Neuland|OpenSimulator-Club - Open Neuland]]
| 216
| 384
| 60
|-
| [[Grid List/Wilder-Westen|OpenSimulator-Club - Wilder Westen]]
| 41
| 122
| 36
|-
| [[Grid List/Myopengrid.com|MyOpenGrid]]
|  
|  
|  
|-
| [[Grid List/Your Alternative Life|Your Alternative Life]]
| 47
| 2089
| 1458
|-
| [[Grid List/Openvue|Openvue]]
| 16
| 24
| 64
|-
| [[Grid List/Logicamp|Logicamp - Outdoor Grid]]
| 179
| 3300
| 577
|-
| [[Grid List/Jamgrid|Jamgrid]]
| 15
| 55
| 15
|-
| [[Grid List/JOGrid|Japan Open Grid]]
| 158
| 682
| 142
|-
| [[Grid List/Tlön|Tlön]]
| 11
| 65
| 10
|-
| [[Grid List/PMGrid|PMGrid]]
| 80
| 100
| 10
|-
| [[Grid List/jokaydiagrid|jokaydiaGRID]]
| 20
| 253
| 75
|-
| [[Grid List/Craft-World|Craft-World]]
| 207
| 9429
| 607
|-
| [[Grid List/Virtual RP|Virtual RP]]
| 17
| 714
| 55
|-
| [[Grid List/GerGrid|GerGrid]]
| 98
| 408
| 25
|-
| [[Grid List/AnSky|AnSky]]
| 14
| 106
| 6
|-
| [[Grid List/Virtual Worlds Grid|Virtual Worlds Grid]]
| 527
| 30
| 4
|-
| [[Grid List/3DGrid World|3DGrid World (formerly The SecondLearning Grid)]]
| 4
| 55
| 46
|-
| [[Grid List/Sofitek|Sofitek]]
| 8
| 21
| 21
|-
| [[Grid List/Dorenas World|Dorenas World]]
| 143
| 448
| 300
|-
| [[Grid List/Speculoos|Speculoos]]
| 30
| 50
| 35
|-
| [[Grid List/Pathlandia|Pathlandia]]
| 4
| 1
| 30
|-
| [[Grid List/Austria|Austria]]
| 11
| 6
| 9
|-
| [[Grid List/Psychedelia|Psychedelia]]
| 7
| 7
| 11
|-
| [[Grid List/M001|M001]]
| 10
| 4
| 4
|-
| [[Grid List/HyperGrid Plaza|HyperGrid Plaza]]
| 1
| 100
| 10
|-
| [http://adreans-world.from-fl.com/home/ Adreans-World]
| 147
| 518
| 43
|-
|[http://www.jopensim.com jOpenSimWorld]
| 39
| 327
| 39
|-
|[[Grid List/RevWorld|Rev World]]
| 56
| 1461
| 256
|-
|[[Grid List/Littlefield_Grid|Littlefield Grid]]
| 351
| 2078
| 383
|-
| [[Grid List/Alife Virtual|Alife Virtual]]
| 500
| 10000
| 1000
|-
|[[Grid List/Athabasca University|Athabasca University]]
| 16
| 15 (in development stage)
| 15
|-
| [[Grid_List/IgnisFatuus|Ignis Fatuus]]
| 47
| 14
| 72
|-
| [[Grid List/DigiWorldz|DigiWorldz]]
| 6907
| 8582
| 2315
|-
| [[Grid List/gimisaOS|gimisaOS]]
| 10
| 1
| 30
|-
| [[Grid List/DSGrid|DSGrid]]
| 17
| 52
| 71
|-
| [[Grid List/Regno di Camlaan|Regno di Camlaan]]
| 8
| 19
| 60
|-
| [http://partydestinationgrid.com Party Destination Grid]
| 120
| 1500
| 1050
|-
| [[Grid_List/pathway_universe|pathway universe]]
| 26
| 60
| 2
|-
| [[Grid_List/Neverworld_Grid|Neverworld Grid ]]
| 328
| 1221
| 383
|-
|[[Grid List/Zone Nations|Zone Nations®]]
| 31
| 6107
| 3678
|-
|[http://www.vibel.eu Vibel]
| 15
| 839
| 839
|-
| [[Grid List/Anetteswelt|Anetteswelt]]
| 143
| 5
| 5
|-
| [[Grid List/openmanniland|openmanniland - OpenSim 0.9.2.0, oswp Webinterface and DTL/NSL MoneyServer]]
| 10
| 5
| 5
|-
| [[Grid List/ReactionGrid|ReactionGrid]]
| 76
| 9756
| 406
|-
| [[Grid List/GorGrid|GorGrid]]
| 10
| 31
| 58
|-
| [[Grid List/Outworldz|Outworldz]]
| 170
| 826
| 161
|}

<br/>

== Inactive Public grids ==

{{ambox
| type = inactive
| text = This is a list of Grids that been inactive for a few days and or have claimed to be inactive by the owner. [[Category:Grid List]]
}}

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" valign="bottom"
! Grid Name
! # Regions
! Approx # Users
! Unique last 30days
|-
| [[Grid List/Cybergrid|Cybergrid]]
| 1
| 44
|  
|-
| [[Grid List/MOSES|MOSES: Military Open Simulator Enterprise Strategy]]
| 117
| 227
| 102
|-
| [[Grid_List/SirinHGpole-Grid|SirinHGpole-Grid]] (regions merged into OSGrid)
| 238
| 120
| 70
|-
| [[Grid List/The New World Grid|The New World Grid]]
| 330
| 5200
| 590
|-
| [[Grid List/Uvatar|Uvatar]]
|  ???
|  ???
| 0 
|-
| [[Grid List/Cyberlandia|Cyberlandia]]
| 185
| 1600
| 269
|-
|[[Grid List/CloneLife|Clone Life]]
| 31
| 6107
| 3678
|-
| [http://www.goreanlifestyle.com/ Gorean Life Style]
|30
|50
|45
|-
| [[Grid List/COSIE Grid|COSIE Grid]]
| 6
| 3
| 3
|-
| [[Grid List/H omeland3D|Homeland3D]]
| 40
| 4
| 4
|-
| [http://www.meetinstantly.com/ MeetInstantly]
| 32
| 5
| 5
|-
|[[Grid List/Traduverse|Traduverse]]
| 49
| 27
| 27
|-
| [[Grid List/Regno di Camlaan|Regno di Camlaan]]
| 8
| 19
| 60
|-
| [[Grid List/AndromedaGrid|Andromeda Grid]]
| 10
| 4
| 0
|-
| [[Grid List/EduGrid|EduGrid]]
| 15
| 2000
| 50
|-
|[https://web.archive.org/web/20110602161855/http://virtualhighway.us:80/ Virtual Highway]
| 706
| 6318
| 285
|-
| [[Grid List/Ice Grid|Ice Grid]]
| 40
| 32
| 5
|-
| [[Grid List/ART|ART]]
| 3(real)
| ? (real)
| 150(real)
|-
| [[Grid List/Stone Grid|Stone Grid]]
| 3
| 4
| 4
|-
| [[Grid List/LifeStyle3D - ItalianGrid|LifeStyle3D - ItalianGrid]]
| 32
| 350
| 108
|-
| [[Grid List/My3dLife|My3DLife]]
| 10
| 20
| 3
|-
| [[Grid List/DaseinWorld|DaseinWorld]]
| 16
| 3
| 3
|-
| [[Grid List/OpenSim Creations Grid|OpenSim Creations Grid]]
| 15
| 11
| 10
|-
| [[Grid List/StarGates Matrix|StarGates Matrix]]
| 5
| 7
| 3
|-
| [[Grid List/You3D|You3D]]
| 11
| 6
| 6
|-
| [[Grid List/Virtual Realms Grid|Virtual Realms Grid]]
| 8
| 10
| 3
|-
| [[Grid List/Gor Grid|Gor Grid]]
| 8
| 10
| 10
|-
| [[Grid List/Enakai|Enakai]]
| 16
| 14
| 34
|-
| [[Grid List/Greeklife|GreekLife]]
| 30
| 50
| 35
|-
| [[Grid List/EverWorlds.com|EverWorlds: Bringing People Together (formerly Destiny Zero)]]
| 17
| 2
| 3
|-
| [[Grid List/IcaruSRealmS|=IcaruS= RealmS]]
| 26
|  
| 14
|-
| [[Grid List/lpgrid.com|Lost Paradise]]
| 2847
| 820
| 670
|-
| [[Grid List/Valhalla Virtual|Valhalla Virtual]]
| 9
| 25
| 4
|-
| [[Grid List/Cyber Wrld|Cyber Wrld]]
| 5
| 8
| 8
|-
| [[Grid List/FleepGrid|FleepGrid]]
| 11
| 150
|
|-
| [[Grid List/Lisat|ArtGridOnLine]]
| 12
| 48
| 15
|-
| [[Grid List/EU-Grid|EU-Grid]]
| 10
| 350
|  
|-
| [[Grid List/GiantGrid|GiantGrid]]
| 169
| 261
| 157
|-
| [[Grid List/pseudospace|Pseudospace]]
| 12
| 46
|  
|-
| [[Grid List/Metapocalypse|Metapocalypse Grid]]
|  
|  
|  
|-
| [[Grid List/UFSGrid|UFSGrid]]
| 36
| 897
| +/-50
|-
| [[Grid List/Unica|Unica]]
| 16
| 60
| 10
|-
| [[Grid List/LISAT|Lost-in-Space-and-Time]]
|  
|  
|  
|-
| [[Grid List/Rezzable Visions|Rezzable Visions]]
|  
|  
|  
|-
| [[Grid List/SimValley NL|SimValley NL]]
| 1087
| 364
| 32
|-
| [[Grid List/Your2Live|Your2Live]]
| 3
| 8
| *
|-
| [[Grid List/OPENSIM NL|OpenSim NL]]
| 9
| 426
| 34
|-
| [[Grid List/VirtualFrance3D|VirtualFrance3D]]
| 16
| 143
| 31
|-
| [[Grid List/Twisted Sky|Twisted Sky]]
| 60
| 290
| 68
|-
| [[Grid List/REDISIS|redOasis (formerly RedIsis)]]
| 130
| 60
| 20
|-
| [[Grid List/PearGrid|PearGrid]]
| 18
| 34
| 8
|-
| [[Grid List/Island Oasis|Island Oasis]]
| 212
| 9107
| 860
|-
| [[Grid List/HAVEN: Your World|HAVEN: Your World]]
| 13
| 11
| 7
|-
| [[Grid List/Flatlandia.cc|Flatlandia]]
| 33
| 177
| 110
|-
| [[Grid List/TertiaryGrid|Tertiary Grid]]
| 41
| 379
| 42
|-
| [[Grid List/Annuna Grid|Annuna Grid]]
| 60
| 60
|  
|-
| [[Grid List/VeeSome|VeeSome]]
| 48
| 106
| 53
|-
| [[Grid List/VirtuaLife|Virtualife]]
| 132
| 1000
| 500
|-
| [[Grid List/Avatar Hangout|Avatar Hangout (with OMC)]]
| 73
| 8,626
| 58
|-
| [[Grid List/DGP Grid|DGP Grid]]
|  
|  
|  
|-

| [[Grid List/tescos.org.uk|tescos.org.uk (curency ƒ)]]
| 30
| 20
| 20
|-
| [[Grid List/Role Play Worlds|Role Play Worlds - Your Fantasy, your world]]
| 129
| 2276
| 298
|-
| [[Grid List/Avatrian|Avatrian]]
| 11
| 25
| 150
|-
| [[Grid List/OSBEST|OSBEST]]
| 12
| 8
| 8
|-
| [[Grid List/MCM Realm|MCM Realm]]
| 22
| 73
| 23
|-
| [[Grid List/Oasis Grid|Oasis Grid]]
| 89
| 3068
| 228
|-
| [[Grid List/AtMeeting|AtMeeting Grid]]
| 20
| 30
| 25
|-
| [[Grid List/OpenUtopia|OpenUtopia Grid]]
| 1
| 3
| 3
|-
| [[Grid List/Virtualgames3d|Virtualgames3d]]
| 140
| 1350
| 500
|-
| [[Grid List/Grid4Us|Grid4Us]]
| 22
| 130
| 50
|-
| [[Grid List/K-grid|K-grid]]
|  
|  
|  
|-
| [[Grid List/Le Monde de Darwin|Le Monde de Darwin]]
| 73
| 83
| 36
|-
| [[Grid List/NeXtLife|NeXtLife Grid]]
| 15
| 7
| 7
|-
| [[Grid List/Sensation Games|Sensation Games]]
| 1
| 2
| 1
|-
| [[Grid List/SLI-Grid|SLI-Grid]]
| 5
|  
|  
|-
| TGGrid
| 11
| 9
| 13
|-
| [[Grid List/4AllGrid|4AllGrid]]
| 68
| 6
| 23
|-
| [[Grid List/AlphaTowne|Alpha Towne]]
| 308
| 1172
| 909
|-
| [[Grid_List/AstralGrid|AstralGrid]]
| 70
| 40
| 30
|-
| [[Grid_List/Avination|Avination]]
| 110
| 300
| 20
|-
| [[Grid_List/EduverseGrid|EduverseGrid]]
| 147
| 400
| Data Unknown
|-
| [[Grid List/German Grid|German Grid]]
| 107
| 2353
| 385
|-
| [[Grid List/Heritage Key|Heritage Key]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/ccdbbs.com|LPgrid]]
| 345
| 331
| 0
|-
| [[NewtonGrid]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/RPGRID_NL|RPGRID NL]]
| 30
| 141
| 16
|-
| [[Grid List/ScienceSim|ScienceSim]]
| 25
| 30
| 15
|-
| [[Grid_List/SkyLifeGrid|SkyLifeGrid]]
| n/a
| n/a
| n/a
|-
| [[Grid_List/slitalia|Slitalia]]
| 7
| 10
| n/a
|-
| [[Grid_List/SunlightGrid|SunlightGrid]]
| 167
| 503
| n/a
|-
| [[Grid_List/Taekwondoverse|Taekwondoverse]]
| 162
| 400
| Data Unknown
|-
| [[Grid_List/Virtual_Life|Virtual Life]]
| 34
| 1004
| n/a
|-
| [[Grid_List/VirtuLife|VirtuLife]]
| 21
| 10
| n/a
|-
| [[Grid List/virtyou|virtyou]]
| 110
| 1676
| 70
|-
| [[Grid_List/World4US|World4US]]
| 25
| 37
| n/a
|-
| [[Grid List/digsynth.com|World of the Free]]
| 0
| 0
| 0
|-
| [[Grid_List/YrGrid|YrGrid]]
| 33
| 2150
| n/a
|-
| [[Grid List/Zairus Grid|Zairus Grid]]
| 72
| 10
| 3

|}

== Office Hour ==

Each week on Tuesday, OSGrid hosts an official Office Hour where the OpenSimulator developers meet and discuss the weeks software development activities. This is a good place to get to know what is going on with OpenSimulator.

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
!Grid
!Region
!Time
|-
|[http://osgrid.org/ OSGrid]
|Wright Plaza
|Tuesday 11:00AM Pacific Time (USA)
|-
|[http://logicamp.org/ logicamp MainGrid]
|Logicamp
|Friday 11:00 - 12:00 GMT+1
|-
|[http://www.lfgrid.com Littlefield Grid]
|Monthly Grid Status Meeting - Smithville Region - lfgrid.com:8002:smithville
|First Friday of the Month 1:30PM PSD
|-
|[http://www.hypergrid.org Metropolis Metaversum]
|Weekly "Stammtisch" Meeting on Region *CenterWorld*
|Every Wednesday 21:00 - 22:00 <br>(GMT/UTC + 1)
|}

== Grid Test Hours ==

Several grids provide valuable testing information for the project, each run a special 'test' hour to test capabilities of the platform. These are run at the same time every week. It may also be a good chance to meet people who can answer questions you may have.

{| cellspacing="0" cellpadding="5" border="1" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
!Grid
!Region
!Time
|-
|[http://francogrid.org/ FrancoGrid]
|Orion
|Everydays 2100GMT+1
|-
|[http://logicamp.org/ Logicamp]
|Logicamp
|Generally Mondays 0900 GMT+1
|}

= See Also =

* [[Grid Associations]]
* [[Public Hypergrid Nodes|HyperGrid Nodes]]

[[Category:Grids]]

NAT Loopback Routers

2021-04-13T23:05:36Z

Ferd Frederix: /* Router / Modem Table */ From https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

If solving the problem by configuring your router turns out not to be possible, you can work around it by setting up some IPTable rules on the computer you're using to browse the web (assuming it's a GNU/Linux OS). For details see the NAT Loopback [[Iptables-script]].

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || TM1602G || Not Working || Arris Touchstone from Spectrum
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
|Netgear || Nighthawk Pro Gaming XR700 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk Pro Gaming XR300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX80/ RAX75 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX50/ RAX45 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX40/ RAX35 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX20/ RAX15 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RAX200 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk RS400 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R9000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8500 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8300 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R8000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7960P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7900 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7500v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7300DST ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7200/ R7350/ R7400/ R7450 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7000 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900P ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900V1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R7100LG ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6900v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v3 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6700v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6400v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6300v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6260/R6330/ R6350/ R6850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6250 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6220/ R6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6120 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6080 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6050/JR6150 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Nighthawk R6020 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR850 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR750 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR50v1 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR40 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR20 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Orbi RBR10 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C3700v2 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6220 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7100V ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C7800 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
|Netgear || Cable Modem C6230 ||Works || [https://kb.netgear.com/000049578/Which-NETGEAR-routers-support-NAT-loopback]
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Tp-Link || AX1500 Wifi 6 || Not Working || TCP does loop back, but not UDP between regions. Works if you add one entry per port, (no 8004-8100) but its limited in the number of entries. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

[[NAT_Loopback|Windows 10 NAT Loopback notes]]

External links:

* [http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html Windows XP NAT Loopback]

* [http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/|Windows 7 NAT Loopback]

* [https://www.youtube.com/watch?v=yIrDvVjyiMk|Windows 8, 8.1, 10 NAT Loopback]

[[Category:Hardware]]

See also: [[Network_Settings#DynDNS_loopback|Using DynDNS for NAT Loopback with Windows, MacOS, or Linux]]

Talk:Server Commands

2021-03-25T16:47:20Z

Ferd Frederix:

----
debug packet <level> and emergency-monitoring seem to do nothing other than throw an error

--[[User:Ferd Frederix|Mikebert]] 2021-03-25 11:46:00 SL+2

----

The help in the server console lists a couple of 'export' commands as well, which aren't mentioned on this page:
* export
* export-map
It would be nice to get some detail on these commands. In particular (what I'm looking for at the moment) is to know how to update each region in the world map. The minimap shows the current terrain, but the world map is still showing the default terrain. [[User:Karora|Karora]] 22:36, 12 February 2009 (UTC)

----

Also missing to explain "link-mapping"
--[[User:Mikebert|Mikebert]] 06:19, 2 March 2009 (UTC)
----
I am deleting the final section [Other] as it no longer applies.
I am eternally grateful to ....darn! can't seem to find the log entry now
am thinking melanie... but I can't say for sure
command line entries on console have been buffered for quite a while now.
This section is ... I think the word is deprecated :-)
--[[User:PocoLoco|PocoLoco]] 07:47, 11 March 2009 (UTC)

----
from irc:
terrain load doesn't need 256x256 anymore.
I you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY>
miyanokouji where regionX and regionY are the coordinates of the bottom-left region.

[[User:Markuser|Markuser]] 16:28, 9 June 2009 (UTC)

Server Commands

2021-03-25T16:44:30Z

Ferd Frederix: /* Terrain Commands */ Add note on terrain load

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID,m which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file. (see note1)
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

Note1 : If you have a sim with multiple regions and you want to set all regions on that sim to be from one larger image you can use 'terrain load <file> <width in regions> <height in regions> <regionX> <regionY> where regionX and regionY are the coordinates of the bottom-left region.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Server Commands

2021-03-25T16:41:42Z

Ferd Frederix: /* terrain modify */ dead link?

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID,m which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0 (dead link)

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - simulator frames per second
* PhyFPS - physics frames per second
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

FSAssets Service

2021-01-20T22:18:47Z

Ferd Frederix: /* Migration */ Add timeout parameter for large blog issues and timeouts

{{Languages|FSAssets_Service}}
=FS Assets=
FSAssets is intended for larger grids where the size of the database is expected to exceed 50GB. This option will save the assets to the file system as opposed to the default service which stores assets as blobs in the database. This option also provides deduplication abilities, each asset is hashed when it is received for storage and if the asset already exists, the asset service will link to the existing file rather than store two copies.

==Config Options==
To enable FSAssets, open Robust.ini or Robust.HG.ini depending on whether you are running a standard or hypergrid enabled grid and find the AssetService section. Change the LocalServiceModule from the current option to:

LocalServiceModule = "OpenSim.Services.FSAssetService.dll:FSAssetConnector"

Also uncomment the following required settings, these are specific to FSAssets:

BaseDirectory = "./fsassets/data"
SpoolDirectory = "./fsassets/tmp"

The following are optional FSAsset config options:

;FallbackService = "OpenSim.Services.AssetService.dll:AssetService"
;DaysBetweenAccessTimeUpdates = 30

;StorageProvider = ""
;ConnectionString = ""
;Realm = "fsassets"

* '''BaseDirectory'''
::This is the folder in which the asset data will be saved.
* '''SpoolDirectory'''
::The spool directory is a folder used for temporary storage while the asset is hashed and compressed before it gets moved to the BaseDirectory. This must be on the same file system as the base directory.
* '''FallbackService'''
::If you are upgrading from the default asset service, uncomment this and set the default asset connector. This will allow FSAssets to retrieve an existing asset from the old service and add it to the BaseDirectory. The fallback service is checked when an asset is requested but not found by FSAssets.
* '''DaysBetweenAccessTimeUpdates'''
::By default, the access time is updated each time an asset is requested. This option can be used to skip this update for assets that already have a recent access time and reduce calls to the database.
* '''StorageProvider'''
::To change where the metadata is saved you can set a specific storage provider and connection string. If this is disabled, the default storage provider given in the database section will be used to save metadata.
* '''ConnectionString'''
::DB connection string for the optional StorageProvider mentioned above.
* '''Realm'''
::The table name to save metadata in the database. Default is 'fsassets'

==Migration==
While FSAssets will use the FallBackService if set, to convert any existing assets when they are requested and not found, this will not automatically convert all the old assets to the new service. To convert all assets from the default service there is a console command provided:
<pre>
import <conn> <table> [<start> <count>]
</pre>
The import command expects a database connection string and the name of the legacy asset table to be passed as parameters. The following example shows how to start the import process for a MySQL database, just change the connection details to match your database schema, username and password:
<pre>
import "Data Source=localhost;Database=SCHEMA;User ID=USER;Password=PASS;Old Guids=true;" assets
</pre>
Depending on the size of your existing assets table, the import process will take some time to complete. The optional parameters, start and count allow you to specify the position and number of rows to convert.

If the import command fails with a timeout error., add "command timeout=300;" to the connection string:

<pre>
import "Data Source=localhost;Port=3306;Database=Robust;User ID=SomeRobustuser;Password=Somerobustpassword;Old Guids=true;Command Timeout=300;" assets
</pre>

The timeout is in minutes, and the default is only 30 seconds.

==Hypergrid Assets==
If your grid has hypergrid enabled, you probably have it setup to use the HGAssetService for sharing assets with other grids. In this situation you will need to change the HGAssetService section of your Robust.ini to point to the FSAssets version of the HGAssetService known as HGFSAssetService.

To enable the HGFSAssetService, find the HGAssetService section of your Robust.ini, the LocalServiceModule should be changed to:

LocalServiceModule = "OpenSim.Services.HypergridService.dll:HGFSAssetService"

NAT Loopback Routers

2020-12-04T05:18:00Z

Ferd Frederix: /* Router / Modem Table */ add ax 1500

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

If solving the problem by configuring your router turns out not to be possible, you can work around it by setting up some IPTable rules on the computer you're using to browse the web (assuming it's a GNU/Linux OS). For details see the NAT Loopback [[Iptables-script]].

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || TM1602G || Not Working || Arris Touchstone from Spectrum
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Tp-Link || AX1500 Wifi 6 || Not Working || TCP does loop back, but not UDP between regions. Works if you add one entry per port, (no 8004-8100) but its limited in the number of entries. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

[[NAT_Loopback|Windows 10 NAT Loopback notes]]

External links:

* [http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html Windows XP NAT Loopback]

* [http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/|Windows 7 NAT Loopback]

* [https://www.youtube.com/watch?v=yIrDvVjyiMk|Windows 8, 8.1, 10 NAT Loopback]

[[Category:Hardware]]

See also: [[Network_Settings#DynDNS_loopback|Using DynDNS for NAT Loopback with Windows, MacOS, or Linux]]

Server Commands

2020-11-10T20:36:14Z

Ferd Frederix: /* Land Commands */ add land clear as it was missing.

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.
* land clear - Clears all parcels on the land.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID,m which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset <ID> - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

NAT Loopback Routers

2020-08-09T03:59:22Z

Ferd Frederix: /* Router / Modem Table */ TM1602G add

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || TM1602G || Not Working || Arris Touchstone from Spectrum
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback

OsSetSitActiveRange

2020-07-20T04:04:40Z

Ferd Frederix: passive voice change to active voice, punctuation.

{{osslfunc
|function_syntax=osSetSitActiveRange(float range)
|csharp_syntax=
|description= sets a limit on how far a avatar can be to have a sit request accepted, or disable sits.
* range > 0: sit request is silently ignored if a avatar is further than range from the prim.
* range == 0: disables this limit. Region default is used. Currently range is unlimited if a sit target is set or physics can sit the avatar, otherwise 10m.
* range < 0: sits are disabled. Requests are silently ignored.
The range value is stored in the prim, even if the script is removed
|threat_level= None
|permissions= true
|delay=0
|ossl_example=<source lang="lsl">
// Example of osSetSitActiveRange

vector target = <0.0, 0.3, 0.55>;
vector rotate = <0.0, 0.0, 90.0>;
float active_range = 5.0;
key avatar;

debug(string name)
{
active_range = osGetSitActiveRange();
llOwnerSay("active_range for avatar " + name + " is " + (string)active_range);
}

default
{
state_entry()
{
llUnSit(llAvatarOnSitTarget());
llSetClickAction(CLICK_ACTION_SIT);
llSitTarget(target, llEuler2Rot((rotate * DEG_TO_RAD)));
osSetSitActiveRange(active_range);
}

changed(integer change)
{
if (change & CHANGED_LINK)
{
key user = llAvatarOnSitTarget();

if (user != NULL_KEY)
{
avatar = user;
debug(osKey2Name(avatar));
}

else if (user == NULL_KEY)
{
debug(osKey2Name(avatar));
avatar = NULL_KEY;
}

else
{
llResetScript();
}
}
}
}
</source>
|additional_info=This function was added in 0.9.2.0
}}

Talk:Offline Instant Messaging v2

2020-05-15T19:51:52Z

Ferd Frederix: Created page with "This page is just the defaults for Offline IM off. Does anyone have a working setup? ~~~ Ferd Frederix/Fred Beckhusen"

This page is just the defaults for Offline IM off. Does anyone have a working setup?

[[User:Ferd Frederix|Ferd Frederix]] ([[User talk:Ferd Frederix|talk]])
Ferd Frederix/Fred Beckhusen

Estate Support

2019-08-21T20:33:58Z

Ferd Frederix: /* Introduction */ Minort formatting, get rid obsoilete info about commands that are now here.

{{Quicklinks}}
<br />

= Introduction =

Estates in OpenSimulator are supported at the simulator level - these are not stored in a ROBUST service.

Estates are supported in the region console, or when setting up a new estate when a new region is setup. Commands for deletion of estates is currently not possible. At the moment, the only way to do this is by manipulating the region database directly.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

== Sample usage to change a Region to another Estate ==

# estate show
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
# show names
UUID Name HomeURL
00000000-0000-0000-0000-000000000000 Unknown User
461efe20-c098-4685-ab41-ef761538d3bc Test User
# estate create 461efe20-c098-4685-ab41-ef761538d3bc New Estate
Estate 105 created as "New Estate"
# estate link region 105 8c5fdd1b-d25a-4852-97b2-2369d5b99adf
Region 8c5fdd1b-d25a-4852-97b2-2369d5b99adf is now attached to estate 105
# estate show
Estate information for region TestRegion
Estate Name ID Owner
New Estate 105 Test User

== Change the name of an Estate ==

An estate can be renamed through the "estate set name" command.
# estate set name <estate ID> <new name>
== Change the owner of an Estate ==
An estate can have a new owner assigned through the "estate set owner" command.
This command supports two forms, one using the owner's name, and one using the owner's ID.
# estate set owner <estate ID> <FirstName> <LastName>
# estate set owner <estate ID> <owner UUID>

== Use a Viewer ==

Another option is to login to the OpenSimulator installation with a viewer and look at the "Covenant" tab of the "About Land" box.

== Database ==

Alternatively, one could execute the following database command to show owners of all estates referenced by the simulator:

select PrincipalID, FirstName, LastName, EstateID, EstateName from UserAccounts, estate_settings as es where PrincipalID=es.EstateOwner;

= Tasks =

'''TODO: Need to add more tasks as necessary:
* delete estate
'''

= Database tables =

* estate_groups - groups allowed on the estate.
* [[estate_managers]] - managers of the estate.
* estate_map - relates IDs of regions to the estate ID.
* [[Estate_settings]] - holds all estate properties (estate owner, estate name, etc.).
* estate_users - residents allowed in the estate.
* estateban - residents banned from the estate.

= Old notes =

This is the old page contents. It may be useful for historical information.

== SVN r5525 introduced estate support into OpenSimulator. ==

Updating to this or a later revison will create estate support in your instance. It will convert the previous settings file to a set of database tables.

=== The following tables are created ===

regionsettings (this will be dropped and recreated if it existed)
estate_settings
estate_map
estatebans
estate_users
estate_groups
estate_managers

These tables will be created in the region datastore by default.

On conversion, it will set up an environment as close as possible to what existed before.

It auto-creates one estate per region, with default estate IDs, starting from 100. All new estates will be parented by estate 100 as well.
It then places the region in it, converts the old region bans to new estate bans for that estate and sets the new estate flags to defaults.
All the information is saved in the database in the new tables.

Region settings are now really by region, no longer per instance.

This patch causes all regions to revert to the settings from estate_settings.xml. This will repair the loss of ground textures some people have reported with the last patch. However, per-region settings made with the last patch will revert to the settings from estate_settings.xml. This is a trade off and was done to make the most common migration case more robust.

== Estate owners ==

Estate owners are now supported, but have to be entered in the database manually, since no support for this exists in the client. Set the EstateOwner field in estate_settings to the UUID of the user you want to be the estate owner. It will become effective in each region at the next region restart.

== Fixing Estate IDs ==

Previous versions of OpenSimulator did automatically create estates with an EstateID equal to 1 and that ID is stored in the OpenSimulator database. Unfortunately SL based viewer do not work properly with EStateID values between 1 and 5, because these numbers are reserved for Linden Labs internal use.

In the Estate tab of the Estate Manager the estate managers and allowed and banned avatars lists are grayed out, for estates using these reserved EstateID values. To fix this problem, run the SQL statements below to adjust the EstateIDs the following way:

Old New
---------
1 --> 100
2 --> 101
3 --> 102
4 --> 103
5 --> 104

Execute the following command while OpenSimulator is not running:
mysql -u<user> -p<password> <database> < FixEstateID.sql

SQL statements in FixEstateID.sql:
UPDATE estate_groups SET EstateID=100 WHERE EstateID=1;
UPDATE estate_managers SET EstateID=100 WHERE EstateID=1;
UPDATE estate_map SET EstateID=100 WHERE EstateID=1;
UPDATE estate_settings SET EstateID=100 WHERE EstateID=1;
UPDATE estate_users SET EstateID=100 WHERE EstateID=1;
UPDATE estateban SET EstateID=100 WHERE EstateID=1;
UPDATE estate_groups SET EstateID=101 WHERE EstateID=2;
UPDATE estate_managers SET EstateID=101 WHERE EstateID=2;
UPDATE estate_map SET EstateID=101 WHERE EstateID=2;
UPDATE estate_settings SET EstateID=101 WHERE EstateID=2;
UPDATE estate_users SET EstateID=101 WHERE EstateID=2;
UPDATE estateban SET EstateID=101 WHERE EstateID=2;
UPDATE estate_groups SET EstateID=102 WHERE EstateID=3;
UPDATE estate_managers SET EstateID=102 WHERE EstateID=3;
UPDATE estate_map SET EstateID=102 WHERE EstateID=3;
UPDATE estate_settings SET EstateID=102 WHERE EstateID=3;
UPDATE estate_users SET EstateID=102 WHERE EstateID=3;
UPDATE estateban SET EstateID=102 WHERE EstateID=3;
UPDATE estate_groups SET EstateID=103 WHERE EstateID=4;
UPDATE estate_managers SET EstateID=103 WHERE EstateID=4;
UPDATE estate_map SET EstateID=103 WHERE EstateID=4;
UPDATE estate_settings SET EstateID=103 WHERE EstateID=4;
UPDATE estate_users SET EstateID=103 WHERE EstateID=4;
UPDATE estateban SET EstateID=103 WHERE EstateID=4;
UPDATE estate_groups SET EstateID=104 WHERE EstateID=5;
UPDATE estate_managers SET EstateID=104 WHERE EstateID=5;
UPDATE estate_map SET EstateID=104 WHERE EstateID=5;
UPDATE estate_settings SET EstateID=104 WHERE EstateID=5;
UPDATE estate_users SET EstateID=104 WHERE EstateID=5;
UPDATE estateban SET EstateID=104 WHERE EstateID=5;

Estate Support

2019-08-21T20:30:17Z

Ferd Frederix: /* Estate support */ Add details from home page, and 0.8.rc patch http://opensimulator.org/mantis/view.php?id=7046 (tested as working fkb)

{{Quicklinks}}
<br />

= Introduction =

'''Documentation is a work-in-progress'''

Estates in OpenSimulator are supported at the simulator level - these are not stored in a ROBUST service.

Tools for manipulating estates in OpenSimulator are currently extremely poor. The only support in the console is a mechanism for setting up a new estate when a new region is setup. Commands for better managing estates (creation, deletion, etc.) must be added in the future. At the moment, the only way to do this is by manipulating the region database directly.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID which you can get from 'show names'

== Sample usage to change a Region to another Estate ==

# estate show
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
# show names
UUID Name HomeURL
00000000-0000-0000-0000-000000000000 Unknown User
461efe20-c098-4685-ab41-ef761538d3bc Test User
# estate create 461efe20-c098-4685-ab41-ef761538d3bc New Estate
Estate 105 created as "New Estate"
# estate link region 105 8c5fdd1b-d25a-4852-97b2-2369d5b99adf
Region 8c5fdd1b-d25a-4852-97b2-2369d5b99adf is now attached to estate 105
# estate show
Estate information for region TestRegion
Estate Name ID Owner
New Estate 105 Test User
== Change the name of an Estate ==
An estate can be renamed through the "estate set name" command.
# estate set name <estate ID> <new name>
== Change the owner of an Estate ==
An estate can have a new owner assigned through the "estate set owner" command.
This command supports two forms, one using the owner's name, and one using the owner's ID.
# estate set owner <estate ID> <FirstName> <LastName>
# estate set owner <estate ID> <owner UUID>
== Use a Viewer ==
Another option is to login to the OpenSimulator installation with a viewer and look at the "Covenant" tab of the "About Land" box.
== Database ==

Alternatively, one could execute the following database command to show owners of all estates referenced by the simulator:

select PrincipalID, FirstName, LastName, EstateID, EstateName from UserAccounts, estate_settings as es where PrincipalID=es.EstateOwner;

= Tasks =

'''TODO: Need to add more tasks as necessary:
* delete estate
'''

= Database tables =

* estate_groups - groups allowed on the estate.
* [[estate_managers]] - managers of the estate.
* estate_map - relates IDs of regions to the estate ID.
* [[Estate_settings]] - holds all estate properties (estate owner, estate name, etc.).
* estate_users - residents allowed in the estate.
* estateban - residents banned from the estate.

= Old notes =

This is the old page contents. It may be useful for historical information.

== SVN r5525 introduced estate support into OpenSimulator. ==

Updating to this or a later revison will create estate support in your instance. It will convert the previous settings file to a set of database tables.

=== The following tables are created ===

regionsettings (this will be dropped and recreated if it existed)
estate_settings
estate_map
estatebans
estate_users
estate_groups
estate_managers

These tables will be created in the region datastore by default.

On conversion, it will set up an environment as close as possible to what existed before.

It auto-creates one estate per region, with default estate IDs, starting from 100. All new estates will be parented by estate 100 as well.
It then places the region in it, converts the old region bans to new estate bans for that estate and sets the new estate flags to defaults.
All the information is saved in the database in the new tables.

Region settings are now really by region, no longer per instance.

This patch causes all regions to revert to the settings from estate_settings.xml. This will repair the loss of ground textures some people have reported with the last patch. However, per-region settings made with the last patch will revert to the settings from estate_settings.xml. This is a trade off and was done to make the most common migration case more robust.

== Estate owners ==

Estate owners are now supported, but have to be entered in the database manually, since no support for this exists in the client. Set the EstateOwner field in estate_settings to the UUID of the user you want to be the estate owner. It will become effective in each region at the next region restart.

== Fixing Estate IDs ==

Previous versions of OpenSimulator did automatically create estates with an EstateID equal to 1 and that ID is stored in the OpenSimulator database. Unfortunately SL based viewer do not work properly with EStateID values between 1 and 5, because these numbers are reserved for Linden Labs internal use.

In the Estate tab of the Estate Manager the estate managers and allowed and banned avatars lists are grayed out, for estates using these reserved EstateID values. To fix this problem, run the SQL statements below to adjust the EstateIDs the following way:

Old New
---------
1 --> 100
2 --> 101
3 --> 102
4 --> 103
5 --> 104

Execute the following command while OpenSimulator is not running:
mysql -u<user> -p<password> <database> < FixEstateID.sql

SQL statements in FixEstateID.sql:
UPDATE estate_groups SET EstateID=100 WHERE EstateID=1;
UPDATE estate_managers SET EstateID=100 WHERE EstateID=1;
UPDATE estate_map SET EstateID=100 WHERE EstateID=1;
UPDATE estate_settings SET EstateID=100 WHERE EstateID=1;
UPDATE estate_users SET EstateID=100 WHERE EstateID=1;
UPDATE estateban SET EstateID=100 WHERE EstateID=1;
UPDATE estate_groups SET EstateID=101 WHERE EstateID=2;
UPDATE estate_managers SET EstateID=101 WHERE EstateID=2;
UPDATE estate_map SET EstateID=101 WHERE EstateID=2;
UPDATE estate_settings SET EstateID=101 WHERE EstateID=2;
UPDATE estate_users SET EstateID=101 WHERE EstateID=2;
UPDATE estateban SET EstateID=101 WHERE EstateID=2;
UPDATE estate_groups SET EstateID=102 WHERE EstateID=3;
UPDATE estate_managers SET EstateID=102 WHERE EstateID=3;
UPDATE estate_map SET EstateID=102 WHERE EstateID=3;
UPDATE estate_settings SET EstateID=102 WHERE EstateID=3;
UPDATE estate_users SET EstateID=102 WHERE EstateID=3;
UPDATE estateban SET EstateID=102 WHERE EstateID=3;
UPDATE estate_groups SET EstateID=103 WHERE EstateID=4;
UPDATE estate_managers SET EstateID=103 WHERE EstateID=4;
UPDATE estate_map SET EstateID=103 WHERE EstateID=4;
UPDATE estate_settings SET EstateID=103 WHERE EstateID=4;
UPDATE estate_users SET EstateID=103 WHERE EstateID=4;
UPDATE estateban SET EstateID=103 WHERE EstateID=4;
UPDATE estate_groups SET EstateID=104 WHERE EstateID=5;
UPDATE estate_managers SET EstateID=104 WHERE EstateID=5;
UPDATE estate_map SET EstateID=104 WHERE EstateID=5;
UPDATE estate_settings SET EstateID=104 WHERE EstateID=5;
UPDATE estate_users SET EstateID=104 WHERE EstateID=5;
UPDATE estateban SET EstateID=104 WHERE EstateID=5;

Server Commands

2019-08-21T20:16:13Z

Ferd Frederix: /* Estate Commands Add state create from http://opensimulator.org/mantis/view.php?id=7046 - and reformatted set owner */

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
Sample usage:
estate show<enter>
Estate information for region TestRegion
Estate Name ID Owner
My Estate 103 Test User
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName> - Change the owner of an estate. This command supports two forms; this one uses the owner's name.
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms; this one uses the owner's UUID.
* estate create <owner UUID> <estate name> - Must be a user UUID,m which you can get from 'show names'

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

NAT Loopback Routers

2019-08-11T19:46:18Z

Ferd Frederix: /* Router / Modem Table Archer */

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Tp-Link || Archer C2 || Not Working || TCP does loop back, but not UDP. Firmware as of 2019-08-11.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works ||
[http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback

Server Commands

2019-08-11T01:03:57Z

Ferd Frederix: /* revert llUDP changes as not in current code. */

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName>
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms, one using the owner's name, and one using the owner's ID.

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Server Commands

2019-08-11T01:00:09Z

Ferd Frederix: /* fix broken link */

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

These are console commands which are useful in debugging or investigating the LLUDP protocol. For more information, see [[LLUDP_ClientStack]]

* debug lludp packet [--default | --all] <level> [<avatar-first-name> <avatar-last-name>] - Turn on packet debugging. In OpenSimulator 0.7.5 and previous this command was "debug packet". "--default" applies the new logging level to all avatar that login after that point. "--all" applies it to all existing avatars as well.
* debug lludp pool <on|off> - Turn object pooling within the lludp component on or off.
* debug lludp start <in|out|all> - Control LLUDP packet processing.
* debug lludp status - Return status of LLUDP packet processing.
* debug lludp stop <in|out|all> - Stop LLUDP packet processing.

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName>
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms, one using the owner's name, and one using the owner's ID.

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Server Commands

2019-08-11T00:59:09Z

Ferd Frederix: /* added hard to find Debug UDP commands */

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

These are console commands which are useful in debugging or investigating the LLUDP protocol. For more information, see [[LLUDP_ClientStack&action]]

* debug lludp packet [--default | --all] <level> [<avatar-first-name> <avatar-last-name>] - Turn on packet debugging. In OpenSimulator 0.7.5 and previous this command was "debug packet". "--default" applies the new logging level to all avatar that login after that point. "--all" applies it to all existing avatars as well.
* debug lludp pool <on|off> - Turn object pooling within the lludp component on or off.
* debug lludp start <in|out|all> - Control LLUDP packet processing.
* debug lludp status - Return status of LLUDP packet processing.
* debug lludp stop <in|out|all> - Stop LLUDP packet processing.

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide or single region if you use change region.
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName>
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms, one using the owner's name, and one using the owner's ID.

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Debugging

2019-08-11T00:51:01Z

Ferd Frederix: show connections remove useless old rev info.

{{Quicklinks}}

=General=

In general, OpenSimulator is a difficult system to debug due to its high concurrency, complexity and the lack of good tools for Mono on the Linux/Mac side. We won't go through general information about using debuggers here, you can find it elsewhere on the net. However, one thing to note is that the debugger must be capable of ignoring the SelfDeleteException - this is currently used by the XEngine script engine to kill scripts aborted via the llDie() LSL command.

=Thread Dumps=

If the simulator or some aspect of it appears to be frozen, one possibility is that threads are in deadlock for some reason. In this case, a dump of all threads can provide useful information.

In Mono, you can get this dump by sending the SIGQUIT unix signal to the Mono process. You can do this either with CTRL + \ on the console or by a command such as

kill -SIGQUIT <pid>

This dump may be very large. If you are reported this trace for debug purposes, it is essential that it is captured and reported accurately.

If at all possible, please start Mono with the --debug switch so that line numbers are added to traces (there is no major performance penalty on using this switch). This is sometimes the only way to pin down which parts of the code threads may be deadlocked on.

Sending SIGQUIT to Mono may make it unstable. If you do this, you are advised to restart the process in question after all useful debugging information has been captured.

'''Not sure how to achieve the same result on Windows, if this is possible at all. If someone knows would be great to get this section filled in.'''

=Internal tools=

There are also logging statements through the OpenSimulator code, some of which are commented out. Generally these can be uncommented to provide extra useful information, though you may have to resort to adding new log statements.

There are also some internal methods that might be useful.

* Util.PrintCallStack() - This will print the call stack at the time the method is executed before continuing execution. Unfortunately, due to Mono limitations can only work on the current thread.

=Specific areas=
However, there are a few things we say about debugging specific OpenSimulator issues. This section will be expanded as time goes on.

== Initial connection ==
This trips people up a lot because of the complex interplay between different server processes in grid mode and between simulator and viewer, with viewers on both the local LAN and over the Internet. Problems here are generally due to configuration rather than OpenSimulator code issues. See [[Troubleshooting]] for more details.

== Problems after connection established ==
Here are some commands that can help you get more information is you have problems when a connection has already been established (e.g. avatars stopping in place), etc. You can get more help on any of these commands by typing "help <command-name>" on the simulator console.

* debug packet <0-256> [<first-name>] [<last-name>] - this command logs various incoming and outgoing packets depending on the packet level (0-256). This can help determine whether there is any packet flow between simulator and client at all.

* show queues [<full>] - this command shows packet in, out and resent statistics for particular clients, as well as the packets being queued. Monitoring the in and outbound packet numbers will show if packets are getting through between simulator and viewer. If resent is climbing rapidly then its likely you have connection issues since the simulator is having to resend lots of packets that aren't being acknowledged by the viewer. If the Q numbers increase without going down then clients may have extremely small bandwidth limits or the outgoing network connection from the simulator may be overwhelmed.

* show users - show users active on the simulator

* show connections - show information about individual client connections, including their IP address and whether they are active.

== Threadpool Activity ==

A lot of the work in OpenSim is done in tasks that are run on a general-purpose threadpool. You can [[General-Purpose Threadpool|enable logging that shows activity in this threadpool]].

== HTTP Activity ==

Use this console command to enable logging of HTTP requests and responses in OpenSim or Robust:

debug http in|out|all [<level>]

Options:
<pre>
If in or all and
level <= 0 then no extra logging is done.
level >= 1 then short warnings are logged when receiving bad input data.
level >= 2 then long warnings are logged when receiving bad input data.
level >= 3 then short notices about all incoming non-poll HTTP requests are logged.
level >= 4 then the time taken to fulfill the request is logged.
level >= 5 then a sample from the beginning of the data is logged.
level >= 6 then the entire data is logged.
no level is specified then the current level is returned.

If out or all and
level >= 3 then short notices about all outgoing requests going through WebUtil are logged.
level >= 4 then the time taken to fulfill the request is logged.
level >= 5 then a sample from the beginning of the data is logged.
level >= 6 then the entire data is logged.
</pre>

In particular, to get a good idea of the communications flow turn on debug level 5 on both the simulator and Robust to see short snippets from each request and response. This will also show HTTP requests between the viewer and the Simulator.

Warp3DImageModule

2019-07-18T18:31:15Z

Ferd Frederix: RenderMinHeight, RenderMaxHeight from source code settings

[[Image:Warp3DImageModule-Example-OpenVue.jpg|256px|thumb|Example Warp3DImageModule map cell - OpenVue]]
[[Image:Warp3DImageModule-Example-OpenVCE.jpg|256px|thumb|Example Warp3DImageModule map cell - OpenVCE]]
[[Image:Comparemap3dmodule.png|256px|thumb|Comparative Map - Arya on FrancoGrid]]

'''Note: Unfortunately, warp maptile generation has been leaking very large amounts of memory and that is still the case at the present time (February 2014). If you want to use this option, we strongly recommend that you only generate the image once at startup per simulator session.'''

Improved rendering of the OpenSim.ini map tiles is possible by using "Warp3DImageModule" (rather than the default "MapImageModule") for the MapImageModule for any region server. The Warp3dRender engine is included in the standard OpenSimulator build (from version 0.7.1).

Include in OpenSim.ini [Startup] section:
MapImageModule = Warp3DImageModule
TextureOnMapTile = true
DrawPrimOnMapTile = true

Optional settings to remove skyboxes or underwater items is to add these:

RenderMinHeight = -100 ; ranges from -100 upwards
RenderMaxHeight = 4096 ; ranges from 100 to 4096 max.

You can use URL requests of this form for each of your regions...

http://regionserver:port/index.php?method=regionImageUUID

Get the region UUID for each region you want to get the map tile
for... then use the Opensim.exe running host name and port you are
using for that (usually the port for the first region in that
instance). Note its NOT the Robust port if you are using a grid, its
the region server port. Then add the UUID directly (with all hyphens
removed) on the end of the URL root.

* An example served live from the Openvue Grid is http://virtual.aiai.ed.ac.uk:9000/index.php?method=regionImage9c8b6f8f81784a6992dc9feba4646e6b

* A combination to show a grid map is at http://virtual.aiai.ed.ac.uk:8002/resources/map.html

The map cells are served at a resolution of 256x256.

Server Commands

2019-01-25T17:09:50Z

Ferd Frederix: /* Estate Commands */ add estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.

{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== General Server Commands ==

These commands are available in both simulator and robust consoles.

=== General ===

* command-script [scriptfile] - Runs a command script containing console commands.
* quit - shutdown the server.
* show info - show server information (version and startup path). Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show uptime - show server startup time and uptime. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* show version - show server version. Before OpenSimulator 0.7.5 this is only available on the simulator console.
* shutdown - synonym for quit
* get log level - In OpenSimulator 0.7.5 and later, print the current console logging level. In OpenSimulator 0.7.4 and earlier please use the "set log level" command instead without a level parameter.
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information. In OpenSimulator 0.7.4 and earlier, if called without the level argument prints the current level. In OpenSimulator 0.7.5 and later please use the "get log level" command instead. Only available on ROBUST console from OpenSimulator 0.7.5.

=== Debug ===

* debug http [<level>] - Turn on/off extra logging for HTTP request debugging. Only available on robust console from commit 94517c8 (dev code post 0.7.3.1). In current development code (for OpenSimulator 0.7.5) this is debug http in|out|all [<level>] since outbound HTTP messages can also now be logged (this was only possible for inbound before). For more information on this command, see [[Debugging]].

* debug threadpool level <level> - Turn on/off logging of activity in the main threadpool. For more information, see [[General-Purpose Threadpool]].

== Simulator Commands ==

=== General ===

* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* set water height # - sets the height simulator wide (rather than single regions as viewer tools do).
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show modules - show module data
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Map Commands ===

* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* generate map - Regenerates and stores map tile. Only in development code post 0.7.6.

=== Object Commands ===

* backup - Persist currently unsaved object changes immediately instead of waiting for the normal persistence call. This shouldn't normally be required - the simulator persists region objects automatically at regular intervals and on shutdown.
* delete object creator <UUID> - Delete a scene object by creator
* delete object name [--regex] <name> - Delete a scene object by name.
* delete object outside - Delete all scene objects outside region boundaries. This is currently if z < 0 or z > 10000. Object outside these bounds have been known to cause issues with OpenSimulator's use of some physics engines (such as the Open Dynamics Engine).
* delete object owner <UUID> - Delete a scene object by owner
* delete object uuid <UUID> - Delete a scene object by uuid. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* dump object id <UUID-or-localID> - Dump the serialization of the given object to a file for debug purposes.
* edit scale <name> <x> <y> <z> - Change the scale of a named prim
* force update - Force the region to send all clients updates about all objects.
* show object name [--regex] <name> - Show details of scene objects with the given name.
* show object uuid <UUID> - Show details of a scene object with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.
* show part name [--regex] <name> - Show details of scene object parts with the given name.
* show part uuid <UUID> - Show details of a scene object parts with the given UUID. In current dev code (post 0.7.5) this is "show object id" and also allows a local ID.

=== Estate Commands ===
* reload estate - reload estate data
* estate link region <estate ID> <region ID> - Attaches the specified region to the specified estate.
* estate show - This command will show the estate name, ID, and owner for regions currently running in the simulator. This list does not necessarily include all estates that are present in the database.
* estate set name <estate ID> <new name> - Rename an estate
* estate set owner <estate ID> <FirstName> <LastName>
* estate set owner <estate ID> <owner UUID> - Change the owner of an estate. This command supports two forms, one using the owner's name, and one using the owner's ID.

=== Region Commands ===
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* create region [name] [filename] - Create a new region
* delete-region <name> - Delete a region from disk.
* region get - Post OpenSimulator 0.8.0.*. Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* region set - Post OpenSimulator 0.8.0.*. Set certain region parameters. Currently, can set
** agent-limit - The current avatar limit for the region. More usually this is set via the region/estate dialog in a typical viewer. This persists over simulator restarts.
** max-agent-limit - The maximum value that agent-limit can have. Unfortunately, setting it here does not currently persist over server restarts. For that to happen it must be separately set as the MaxAgents parameter in the region config file.
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* restart region <regionname> - Restarts just one sim in an instance. Set the console to the region name first, with 'change region <regionname>', or all regions will restart.
* set region flags <Region name> <flags> - Set database flags for region
* show neighbours - Shows the local regions' neighbours
* show ratings - Show rating data
* show region - Show region parameters (Region Name, Region UUID, Location, URI, Owner ID, Flags).
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)

=== Scene Commands ===

* debug scene - Turn on scene debugging
* rotate scene <degrees> - Rotates scene around 128,128 axis by x degrees where x=0-360.
* scale scene <factor> - Scales all scene objects by a factor where original size =1.0.
* translate scene <x,y,z> - Translate (move) the entire scene to a new coordinate. Useful for moving a scene to a different location on either a Mega or Variable region.
(please back up your region before using any of these commands and be aware of possible floating point errors the more they are used.)

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Stats Commands ===

* show stats - show useful statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* stats show - a synonym for "show stats" (OpenSimulator dev code only post 19th March 2014).
* stats record - record stats periodically to a separate log file.
* stats save - save a snapshot of current stats to a file (OpenSimulator dev code only post 19th March 2014).

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain save-tile - Saves the current heightmap to the larger file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions baked map.
* terrain revert - Loads the baked map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes.
* terrain show - Shows terrain height at a given co-ordinate.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect
* terrain flip - Flips the current terrain about the X or Y axis
* terrain rescale - Rescales the current terrain to fit between the given min and max heights
* terrain min - Sets the minimum terrain height to the specified value.
* terrain max - Sets the maximum terrain height to the specified value.
* terrain modify - Provides several area-of-effect terraforming commands.

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Disable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== Grid Service ===

* set region flags <Region name> <flags> - Set database flags for region
* show region <Region name> - Show the details of a given region. This command is renamed to "show region name" in development versions of OpenSimulator.

The following commands currently only exist in development versions of OpenSimulator (post 0.7.3.1). These are currently found in the "Regions" help section.

* deregister region id <Region UUID> - Deregister a region manually. This can be helpful if a region was not properly removed due to bad simulator shutdown and the simulator has not since been restarted or its region configuration has been changed.
* show region at <x-coord> <y-coord> - Show details on a region at the given co-ordinate.
* show region name <Region name> - Show details on a region
* show regions - Show details on all regions. In standalone mode this version of the command is not currently available - the simulator version of "show regions" is used instead, which shows similar information.

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"

* reset user password - reset a user's password.
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)

=== Login Service ===
* login level <value> - Set the miminim userlevel allowed to login (see [[Userlevel|User Level]]).
* login reset - reset the login level to its default value.
* login text <text to print during the login>
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account or can login at all (0.7.2-dev) (see [[Userlevel|User Level]]).

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

==== terrain modify ====
Allows area-of-effect and tapering with standard heightmap manipulations.

General command usage:
:''terrain modify <operation> value [<mask>] [-taper=<value2>]''

:Parameters
:* value: base value to use in applying operation
:* mask:
:** -rec=x1,y1,dx[,dy] creates a rectangular mask based at x1,y1
:** -ell=x0,y0,rx[,ry] creates an elliptical mask centred at x0,y0
:* taper:
:** rectangular masks taper as pyramids
:** elliptical masks taper as cones

Terrain Manipulation (fill, min, max)
:* value represents target height (at centre of range)
:* value2 represents target height (at edges of range)

Terrain Movement (raise, lower, noise)
:* value represents a delta amount (at centre of range)
:* value2 represents a delta amount (at edges of range)

Terrain Smoothing (smooth)
:The smoothing operation is somewhat different than the others, as it does not deal with elevation values, but rather with strength values (in the range of 0.01 to 0.99). The algorithm is simplistic in averaging the values around a point, and is implemented as follows:

:The "strength" parameter specifies how much of the result is from the original value ("strength" * map[x,y]).
:The "taper" parameter specifies how much of the remainder is from the first ring surrounding the point (1.0 - "strength") * "taper". There are 8 elements in the first ring.
:The remaining contribution is made from the second ring surrounding the point. There are 16 elements in the second ring.
:e.g.
:''terrain modify smooth 0.5 -taper=0.6''
:* the original element will contribute 0.5 * map[x0,y0]
:* each element 1m from the point will contribute ((1-0.5)*0.6)/8 * map[x1,y1]
:* each element 2m from the point will contribute ((1-0.5)*0.4)/16 * map[x2,y2]

Notes:
:The "taper" value may need to be exaggerated due to the integer math used in maps.
:e.g. To create a 512x512 var island:
:''terrain modify min 30 -ell=256,256,240 -taper=-29''

Example:
: https://www.youtube.com/watch?v=pehyqr3H8I0

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

link-mapping

== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

User:Ferd Frederix

2018-12-22T16:02:08Z

Ferd Frederix: edit my page

Fred Beckhusen, aka Ferd Frederix

fred at outworldz.com

[https://www.outworldz.com https://www.outworldz.com]

Talk:OSSL Enabling Functions

2018-12-22T15:59:22Z

Ferd Frederix: Created page with "Needs update to master --~~~~"

Needs update to master

--[[User:Ferd Frederix|Ferd Frederix]] ([[User talk:Ferd Frederix|talk]]) 07:59, 22 December 2018 (PST)

NAT Loopback Routers

2018-12-22T15:56:14Z

Ferd Frederix: /* Router / Modem Table */ Netgear VMDG485

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || VMDG485 || Works ||
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works || [http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback

NAT Loopback Routers

2018-12-22T15:54:05Z

Ferd Frederix: /* openWRT Routers: */ formatting

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works || [http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:
<source lang="bash">
insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE
</source>
Dahlia Trimble

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback

NAT Loopback Routers

2018-12-22T15:50:54Z

Ferd Frederix: /* openWRT Routers: */ Addded code to loopback older openwrt

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works || [http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

This may work for older WRT routers:

insmod ipt_mark

insmod xt_mark

iptables -t mangle -A PREROUTING -i ! `get_wanface` -d `nvram get wan_ipaddr` -j MARK --set-mark 0xd001

iptables -t mangle -A PREROUTING -j CONNMARK --save-mark

iptables -t nat -A POSTROUTING -m mark --mark 0xd001 -j MASQUERADE

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback

NAT Loopback Routers

2018-12-22T15:47:49Z

Ferd Frederix: /* Router / Modem Table */ TD-W8970 Cisco Linksys EA4500 Nighthawk AC1750 and AC1900

{{Quicklinks}} {{content}}

= INTRODUCTION =

What is NAT Loopback and why is it needed to host a public Opensimulator Region?

Currently (as at August 2010), a hosted region on a home connection with a broadband router needs, what is known as ''NAT Loopback'' functionality.

Many DSL routers/modems prevent loopback connections as a security feature. This means that a machine on your local network (e.g. behind your DSL router/modem) cannot connect to a forward facing IP address (such as 199.149.252.44) of a machine that it also on your local network. Connecting to the local IP address (such as 192.168.2.40) of that same machine works fine.

This is an issue since each region has to specify an IP address for the client to connect. This is the ExternalHostName parameter in a regions config file (e.g. bin/Regions/Regions.ini). In the absence of NAT loopback, if a forward facing IP address is specified (such as 199.149.252.44) then external clients will be able to connect to the region but clients on your local network will not. If the internal address were put in ExternalHostName instead (e.g. 192.168.2.40) then viewers on the local network will be able to connect but viewers from an external network would not.

This page shows a list of routers supporting NAT Loopback. Please add both known working and non-working routers to the list.

= Router/Modem Table =
==== Router / Modem Table ====
(this information gathered from the OpenSimulator WIKI and OSGrid forums information collectively and assembled into this sortable formatted table for ease of use and quick access. Links provided are either to the Manufactures pages or Pages which can further assist in configuration and troubleshooting.)

{| cellspacing="0" cellpadding="5" border="1" align="center" style="width: 100%;" class="sortable"
|- style="background-color:#57C604;font-size:10pt;font-weight:bold;border-bottom:1px solid;" align="center" valign="bottom"
| '''Make''' || '''Model''' || '''Status''' || '''Notes'''
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 GT701-WG] || Works || [http://portforward.com/english/routers/port_forwarding/Actiontec/GT701WG/default.htm] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver. [http://forums.osgrid.org/viewtopic.php?f=5&t=3339&p=14576&hilit=actiontec#p14576 OsGrid Forum post] showing how to get it to work on Linux.
|-
| Actiontec || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992 Verizon FiOS Router Model # 424WR] || Works || [http://www.dslreports.com/faq/verizonfios/3.1_Actiontec#15992] Verizon FIOS and Frontier networks with TV and Phone service may require bypassing the ActionTech with another router. Loopback does not work reliably between ports so teleports are unreliable without a loopback driver.
|-
| Airlink || Airlink 101 Super G || Works || older model, search for reference
|-
| Airlink || Airlink 101 802.11G wireless || Works || older model, search for reference
|-
| Apple || [http://www.apple.com/airportextreme/ AirPort Extreme] || Works ||
|-
| Arris || TM502b || Works || [http://portforward.com/english/routers/port_forwarding/Arris/TM502b/]
|-
| Arris || BGW210-700 || Loopback is flaky || Software Version 1.7.17 [https://forums.att.com/t5/AT-T-Internet-Equipment/Port-forwarding-has-stopped-working-on-my-arris-bgw210-700/td-p/5617287]
|-
| Astoria Networks || Bright Box Wireless Router || Not Working || |
|-
| Asus || [http://www.asus.com/Networks/Wireless_Routers/WL520gC/ WL-520GC] || Works || [http://portforward.com/english/routers/port_forwarding/Asus/WL-520GC/defaultguide.htm]
|-
| AVM || FRITZ!Box || Works || [http://www.avm.de/en/Produkte/FRITZBox/index.html] Except 3790 VDSL Router (old stock)
|-
| Belgacom BBox-2 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-2 Docs] || Works || Also known as [http://www.sagemcom.com/index.php?id=1226&L=0 SAGEM 3464]. BBox-1 work, BBox-2 = Method 1: flash the firmware (in this case we lose the guarantee provider) Method 2: Configure Bbox Bridge mode and put a second router for OpenSim-Sim. [http://logicamp.forumpro.fr/t7-nat-loopback-b-box2-belgacom LOGICAMP tuto (in french)]
|-
| Belgacom BBox-3 || [https://www.proximus.be/support/fr/id_sfaqr_mdm_manual/particuliers/bienvenue-sur-le-support/internet/internet-a-la-maison/installation-et-cablage/guide-d-installation-du-modem-b-box-3v-b-box-3-etc.html BBox-3 Docs] || Works || The Technicolor Model of BBox-3 have Nat Loopback BUT the Sagem Model NOT. You can ask Belgacom to give you a Technicolor model or you can go change it in shop. (Last Update 01-01-2018).
|-
| BT || BT Home Hub V2 || Works || [http://portforward.com/english/routers/port_forwarding/BT/BT_Home_Hub_v2/defaultguide.htm]
|-
| BT || BT Home Hub 3 (model B) || Works || [Tested using firmware V100R001C01B031SP12_L_B on standalone ]
|-
| BT || BT2700HGV || Works || [ http://portforward.com/english/routers/port_forwarding/BT/BT2700HGV/defaultguide.htm]
|-
| Cisco || [http://www.cisco.com/en/US/products/ps9925/index.html RV042] || Works ||
|-
| Dlink || [http://www.dlink.com/products/?pid=DGL-4500 DGL-4500] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4500/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=370 DGL-4300] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DGL-4300/defaultguide.htm]
|-
| Dlink || [http://www.dlink.ca/products/?tab=3&pid=DI-524&rev=DI-524 DI-524] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DI-524/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-600 DIR-600] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-600/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-601 DIR-601] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-601/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-625 DIR-625] || Not Working || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-625/defaultguide.htm]
|-
| Dlink || [http://support.dlink.com/ProductInfo.aspx?m=DIR-628 DIR-628] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-628/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-635 DIR-635] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-635/defaultguide.htm]
|-
| Dlink || [http://www.dlink.com/products/?pid=DIR-655 DIR-655] || Works || [http://portforward.com/english/routers/port_forwarding/Dlink/DIR-655/defaultguide.htm] Current hardware version "B" doesn't work.
|-
| Dlink || [http://us.dlink.com/us/en/home-solutions/connect/routers/dir-835-wireless-n750-dual-band-router.html DIR-835] || Not working || [https://portforward.com/d-link/dir-835/]
|-
| Dlink || [http://www.dlink.com/uk/en/home-solutions/connect/modems-and-gateways/dsl-2680-wireless-n-150-adsl2--home-router DSL-2680] || Not Working ||
|-
| Dlink || DSL-3680 || Works || Needs manual configuration. Guide at [https://www.digitalnut.co.uk/blog/talktalk.html], backup at [http://franciknow.scot/vw/tech.html]
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=71 Vigor120] || Works || Nat Loopback out of the box. Great router.
|-
| Draytek || [http://www.draytek.com/user/PdInfoDetail.php?Id=82 Vigor2710] || Works || [http://portforward.com/english/routers/port_forwarding/DrayTek/Vigor_2710n/defaultguide.htm] firmware 3.2.4.3 (or higher).
|-
| Inventel / Livebox || DV42190WA || Works || Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately
|-
| Linksys/Cisco || Linksys EA4500 || Works ||
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/BEFSR41/ BEFSR41] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/BEFSR41/defaultguide.htm]
|-
| Linksys/Cisco || RT31P2 || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/RT31P2/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/APAC/en/support/AG241 AG241] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/AG241/defaultguide.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/EU/en/support/WAG200G WAG200G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG200G/default.htm] Firmware Version: 1.01.09 or better
|-
| Linksys/Cisco || [http://en.wikipedia.org/wiki/Linksys_WRT54G_series WRT54G] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WRT54G/default.htm]
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/WAG160N WAG160N] || Works || [http://portforward.com/english/routers/port_forwarding/Linksys/WAG160N/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v3] || Works ||
|-
| LinkSys/Cisco || [http://www.linksys.com/us/p/P-WRT1200AC/ WRT1200AC] || Works ||
|-
| Linksys/Cisco || [http://www.linksysbycisco.com/ANZ/en/products/E3000 E3000] || Works || [http://portforward.com/english/routers/port_forwarding/Cisco/Linksys-E3000/default.htm]
|-
| Linksys/Cisco || [http://homesupport.cisco.com/en-us/wireless/lbc/WAG54G WAG54G v2 - NZ/AU] || Works || Faster processor, more memory and larger NAT table
|-
| Linksys/Cisco || WAG120N || Works ||
|-
| Linksys/Cisco || Linksys RT31P2 || Works ||
|-
| Netgear || Nighthawk AC1750 || Works || [https://portforward.com/netgear/ac1750-c6300/]
|-
| Netgear || Nighthawk AC1900 || Works ||
|-
| Netgear || WNR834M || Works ||
|-
| Netgear || WNR2000 || Works || With firmware 1.2.3.7 Loop back now enabled 'out of the box'
|-
| Netgear || WGR614 || Works || confirmed to work out of the box
|-
| Netgear || WGR614v9 || Works || with v9 firmware
|-
| Netgear || RP614 || Works || Version 3 or better
|-
| Netgear || DG834G || Works || v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. v5 unknown to work.
|-
| Netgear || Pro Safe VPN FVS318 || Not Working || [http://www.netgear.com/service-provider/products/security/wired-VPN-firewalls/FVS318.aspx#two]
|-
| Netgear || Pro Safe VPN FVS338 || Works || Firmware 3.0.6-25 or over
|-
| Netgear || WGR614 || Not Working || [http://www.netgear.com/home/products/wirelessrouters/simplesharing/WGR614.aspx] does not work with ISP required gateway modems
|-
| Netgear || [http://support.netgear.com/app/products/family/a_id/8213 WNR3500 ] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNR3500/defaultguide.htm] NB restart after configuration
|-
| Netgear || RP614v3 and Newer revisions || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/RP614v3/defaultguide.htm]
|-
| Netgear || [http://www.netgear.com/home/products/wirelessrouters/high-performance/WNDR3700.aspx WNDR3700] || Works || [http://portforward.com/english/routers/port_forwarding/Netgear/WNDR3700/default.htm]
|-
| Pace Plc || 5268AC || Works || [https://portforward.com/pace-plc/5268ac/]
|-
| SMC || [http://www.smc.com/index.cfm?event=viewProduct&cid=1&scid=17&localeCode=EN%5FUSA&pid=924 SMC-7004VBR] || Works || [http://portforward.com/english/routers/port_forwarding/SMC/SMC7004ABR/defaultguide.htm]
|-
| Telstra Technicolor || TG799vac || Works || [https://portforward.com/technicolor/tg799vn/]
|-
| Thomson SpeedTouch || TG585 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585/default.htm] new ver. Only
|-
| Thomson SpeedTouch || ST-585i || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch585i/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-780 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/ST780/default.htm] May need to enable loopback through telnet
|-
| Thomson SpeedTouch || ST-516 || Works || [http://portforward.com/english/routers/port_forwarding/Thomson-Alcatel/SpeedTouch516/default.htm]May need to enable loopback through telnet
|-
| TP_LINK || [https://www.tp-link.com/au/products/details/cat-5030_TD-W8970.html TD-W8970] || Works ||
|-
| TP-Link || TL-WR740N || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| TP-Link || [http://www.tp-link.com/en/products/details/?categoryid=227&model=TL-R470T%2b TL-R470T+] || Works || All TP-Link wired routers are said to support loopback, including the wifi ones. This one has been confirmed by support staff.
|-
| Tp-Link || AC1750 || Works || uPnP forgets settings if port is not used - manually opening of ports works.
|-
| Scientific Atlanta || WebSTAR-DPR2320 || Works || [http://portforward.com/english/routers/port_forwarding/Scientific-Atlanta/WebSTAR-DPR2320/default.htm] Google for more info
|-
| Ubee || DDW2600 || Works || [http://www.ubeeinteractive.com/index.php/products/product-overview/wireless_cable_router1/] Cable Router
|-
| ZyXel || C1000Z (CenturyLink) || Not Working || [https://www.donationcoder.com/forum/index.php?topic=36001.msg338991#msg338991]
|-
| 3Com / HP || 3CRWDR100A-72 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR100A-72/default.htm]
|-
| 3Com / HP || 3CRWDR101A-75 || Works || [http://portforward.com/english/routers/port_forwarding/3com/3CRWDR101A-75/eMule.htm]
|-
| 2wire || 2701hg-s || Not Working ||
|-
| 2wire || 2701hg-B || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-B/default.htm]
|-
| 2wire || 2701hg-D || Works || [http://portforward.com/english/routers/port_forwarding/2wire/2701HG-D/default.htm]
|-
|}

= Notes on Some Routers =

== D-Link ==

D-Link DGL-4500 series of routers have the largest available nat table of any router on the market.  These routers range from 70$-180$ USD depending on where you live and purchase from.

When considering a purchase, consider performance against cost. Upper end ADSL 2+ routers can add several Mbs to your modems sync speed.

'''Wireless Routers - Access Point Only'''

These routers are Access Point devices, and contain no ADSL modem and hence need a separate adsl modem operating in Bridge mode.

* [http://www.dlink.com/products/?pid=64 D-Link DGL-4500]
* [http://www.dlink.com/products/?pid=530 D-Link DIR-655]
* [http://www.dlink.com/products/?pid=DIR-635 D-Link DIR-635]
* [http://www.dlink.com/products/?pid=DIR-601 D-Link DIR-601]
* [http://www.dlink.com/products/?pid=DIR-600 D-Link DIR-600]
* D-Link DI-524

'''Routers With ADSL modem'''
No items to list currently

Note: The DGL-4100 & DGL-4300 have been discontinued, and the replacement model is the DIL-825 and DIL-855 - Loopback status unknown on these later models. The DGL-4300 may be available second hand.

== Netgear ==

* NETGEAR WNR834M : ftp://downloads.netgear.com/files/wnr834m_ref_manual.pdf

* Netgear DG834G v3 with latest firmware & v4 upto firmware version v5.01.09 (according to [http://forum1.netgear.com/showthread.php?t=42641 this link], a later firmware update of v4 removed NAT loopback) NAT Loopback returned as menu option with latest v5.01.16 firmware for the v4 model. The latest model versions, marked v5 on the unit's label, has significantly different internals and is not currently Loopback capable(the v5 has the wireless aerial on the right, not the left, as looking from the front. The DG834G v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers.
* Netgear DGN1000 worked out of the box. Note this working item reports its firmware version as V2.1.00.19_VG which seems much newer than the version offered for download on netgear.com.
* NETGEAR FVS338 : loopback issue with firmware v3.0.3-17 (2008). LAN address is incorrectly presented to simulator instead of WAN address. Fixed in latest update v3.0.6-25 (2010).

== Other routers & Hardware ==

* BT home hub V2
* If you are using a ZyXEL DSL router/modem from Embarq, please read [[OpenSim:Network_settings#A_solution_for_local_connections_when_you_are_using_NAT_and_Port_Forwarding|this configuration guide]]. This will show you how to reconfigure your DSL router/modem to fix this problem.

= KNOWN non-functional for OpenSim: =

* Netgear Pro Safe VPN FVS318 : [http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx http://www.netgear.com/Products/VPNandSSL/WiredVPNFirewallRouters/FVS318.aspx]
* NetGear WGR614 does not work with ISP required gateway modems
* Belkin F5D7230-4 (the router might work if 3rd party firmware is used, such as DD-WRT : http://www.dd-wrt.com/ )

<br />

= REFERENCE LINKS: =

More Information Related to Routers and Solutions @: [http://osgrid.org/forums/viewtopic.php?f=8&t=2283 osgrid.org/forums/viewtopic.php]

= Linux specific solutions =
== SETTING UP A LINUX COMPUTER TO ACT AS A ROUTER ==

----

For Linux based Netfilter (iptables) routers, you want to set up the NAT table with some extra entries The following script is something to get you started, you'll need to fix up the variables at the top to match your system and network. <source lang="bash">
#!/bin/bash
#
# vvvvv - Fix these! - vvvvv
IPTABLES=/usr/sbin/iptables
LAN_NETWORK=192.168.0.0/24
SERVER_IP=192.168.0.2
INTERNET_IP=100.100.100.100
REMOTING_PORT=8895
REGION_PORT=9000
# ^^^^^ - Fix these! - ^^^^^

# First, the Destination NAT, anything going to the external address on our ports, we redirect to the server
# Note, if you have a double NAT running and this router doesn't actually have the internet IP address, you'll
# need another set of PREROUTING-DNAT lines with the --destination (-d) set to the internet facing private address
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REMOTING_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p udp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP
$IPTABLES -t nat -I PREROUTING -d $INTERNET_IP -p tcp --dport $REGION_PORT --jump DNAT --to-destination $SERVER_IP

# Second, the Source NAT, we need this so that returning packets to our LAN clients go back through the router first,
# otherwise, the server will try to talk directly to the client and the client will reject them
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REMOTING_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p udp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
$IPTABLES -t nat -I POSTROUTING -s $LAN_NETWORK -d $SERVER_IP -p tcp --dport $REGION_PORT --jump SNAT --to-source $INTERNET_IP
</source>

--[[User:Hell Fire|Hell Fire]]

== DNS solution ==
It's possible to host your own DNS-server, so you can prevent some of the dns-naming problems mentioned before. If http://example.org resolves to the external ip, and that loopback connection is prevented by your router, you could point your resolv.conf to a local nameserver like:
nameserver 192.168.2.2
Now you need bind/named installed in order to handle the dns-requests. You can find a bind example configfile here.

= openWRT Routers: =

If you use openWRT firmware on your router, check here: [[Users:Thomax:nat-loopback|OpenWRT NATLoopback]]

Table of openWRT supported Hardware, check here: [https://wiki.openwrt.org/toh/start openWRT]

= Windows XP, Windows 7, 8, 8.1, 10 Loopback Adapter Install: =

Please see this -> Windows XP: http://www.windowsnetworking.com/articles-tutorials/windows-xp/Install-Microsoft-Loopback-adapter-Windows-XP.html

Windows 7: http://www.windowsreference.com/windows-7/how-to-install-a-loopback-adapter-in-windows-7/

Windows 8, 8.1, 10 https://www.youtube.com/watch?v=yIrDvVjyiMk

[[Category:Hardware]]

See more potential loopback solutions here: http://opensimulator.org/wiki/Network_Settings#DynDNS_loopback