From OpenSimulator

Revision as of 09:43, 4 September 2008 by Phrearch (Talk | contribs)

Jump to: navigation, search

Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.


How to Setup the Remote Admin

Setup OpenSim

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file:

enabled = true
access_password = secret

Example in Python

# Author  : DrScofield 
# Source  :
# License : BSD License

import xmlrpclib  
# XML-RPC URL (http_listener_port)  
gridServerURL = ‘′  
# instantiate server object  
gridServer = xmlrpclib.Server(gridServerURL)  
# invoke admin_alert: requires password and message  
gridServer.admin_broadcast({’password’: ’secret’,   ‘message’: ‘the answer is 42′})

RemoteAdmin executable for Windows

The RemoteAdmin executable for Windows is a command line tool based on the RemoteAdmin PHP Class.

Downloads and documentation on the RemoteAdmin Executable webpage

Example in PHP

This example needs the RemoteAdmin PHP Class file available here.

// Author  : Olish Newman
// Source  :
// Licence : BSD License
// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 9000, 'secret');
// Invoke admin_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);
// Invoke admin_shutdown (example for use without parameters)
// Invoke admin_create_user (multiple parameters)
$parameters = array('user_firstname' => 'Ruth', 'user_lastname' => 'OpenSim', 'user_password' => 'MyPassword', 'start_region_x' => '1000', 'start_region_y' => '1000');
$myRemoteAdmin->SendCommand('admin_create_user', $parameters);

Note: This script does not appear to work for create user because it tries to pass the start region x and y as a string when the RemoteAdmin needs a string. The class needs to be edited to pass it as a number or edit the remoteadmin source to convert the string to a unsigned int.

Another example in PHP5, using CURL.

//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
class RemotePC {
	function __construct() {
        $this->serveruri = "http://myhost";
        $this->serverport ="9000";
        $this->password ="foobar";
	function call($command,$parameters) {
        $parameters['password'] = $this->password;
	$request = xmlrpc_encode_request($command, $parameters);
	$ch = curl_init();
	curl_setopt( $ch, CURLOPT_URL, $this->serveruri);
	curl_setopt( $ch, CURLOPT_PORT, $this->serverport]);	
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt ( $ch, CURLOPT_POSTFIELDS, $request);
	curl_setopt ( $ch, CURLOPT_TIMEOUT, 5);	
	$result = curl_exec($ch);
	return xmlrpc_decode($result);

RemoteAdmin Commands

Name Status Description Parameters
admin_create_region Create a new region region_name, region_master_first, region_master_last, region_master_password, listen_ip, external_address
admin_shutdown Shut down the simulator No parameter needed
admin_broadcast Send a general alert message
admin_restart Restart Region regionid
admin_load_heightmap Load Height Map... filename, regionid
admin_create_user Create a new user user_firstname, user_lastname, user_password, start_region_x, start_region_y
admin_load_xml Execute the Load XML command filename


Thanks to DrScofield for the Python Script Sources :

Personal tools
About This Wiki