OpenSimulator - User contributions [en]

Automating Tasks

2009-07-01T14:55:55Z

Sean Heavy: /* Linux (CentOS-5) */

__NOTOC__
{{Template:Quicklinks}}

==Automate Grid Startup==
===Windows===
Create a batch file to start up your grid, e.g. startGrid.bat ;

@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i GTR 0 Echo There are %%i OpenSimulator processes running already. I quit! & Goto END

:: %PROGRAMFILES% expands to your normal application path
:: On an English system this is normally C:\Program Files
:: If you run a 64-bit Windows, with OpenSim as a 32-bit
:: application, substitute with %PROGRAMFILES(X86)%

Echo Starting User Server...
start "UserServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.UserServer.exe
sleep 5
Echo Starting Grid Server...
start "GridServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.GridServer.exe
sleep 5
Echo Starting Asset Server...
start "AssetServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.AssetServer.exe
sleep 5
Echo Starting Inventory Server...
start "InventoryServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.InventoryServer.exe
sleep 5
Echo Starting Messaging Server...
start "MessagingServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.MessagingServer.exe
sleep 5
Echo Starting Region Server...
start "RegionServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.exe -gridmode=true

:END

PS! Check that you have sleep command installed, I'm unsure if all Windows versions have that.<br>
If sleep is not installed one can use a localhost ping instead to replace "sleep 3".
PING -n 4 127.0.0.1>nul
This knowledgebase article describes how to add a batch file to startup of Windows (before logon).<br>
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/]<br>
Note that you have to start all applications and answer the configuration questions once before adding it to any startup.<br>
<br>
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

Or a more advanced batch that shut server processes down in the opposite order as recommended in the manual.
@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i EQU 0 Echo There are no OpenSimulator processes running. Nothing to stop.. & Goto END

Echo Stopping Region Server...
taskkill /T /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Region Server was not running! & Echo. & Goto n1
:r1
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Region Server stopped. & Echo. & Goto n1
Goto r1

:n1
Echo Stopping Messaging Server...
taskkill /T /IM OpenSim.Grid.MessagingServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Inventory Server was not running! & Echo. & Goto n2
:r2
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.MessagingServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo IMessaging Server stopped. & Echo. & Goto n2
Goto r2

:n2
Echo Stopping Inventory Server...
taskkill /T /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Inventory Server was not running! & Echo. & Goto n3
:r3
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Inventory Server stopped. & Echo. & Goto n3
Goto r3

:n3
Echo Stopping Asset Server...
taskkill /T /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Asset Server was not running! & Echo. & Goto n4
:r4
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Asset Server stopped. & Echo. & Goto n4
Goto r4

:n4
Echo Stopping Grid Server...
taskkill /T /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Grid Server was not running! & Echo. & Goto n5
:r5
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Grid Server stopped. & Echo. & Goto n5
Goto r5

:n5
Echo Stopping User Server...
taskkill /T /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo User Server was not running! & Echo. & Goto END
:r6
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo User Server stopped. & Echo. & Goto END
Goto r6

:END
(Batch edits, [[User:Suz|Suz]] 04:46, 27 May 2008 (PDT))

===Linux/Mac OS X===
You can use this [[startup_script_linux|startup script]]
* Use Screen Command
Use the screen command to automate startup
* Setup screen command and setup shell file
Linux install:
apt-get install screen (ubuntu)
pacman -S screen (archlinux)
Mac OS X: Download either MacPorts, http://www.macports.org/, or Fink, http://www.finkproject.org/ to download *nix packages
MacPorts
sudo port install screen
Fink
Need command line for Fink.
* Create file runsim.sh
#!/bin/sh
cd opensim/bin
sleep 3
screen -S UserServer -d -m mono OpenSim.Grid.UserServer.exe
sleep 3
screen -S GridServer -d -m mono OpenSim.Grid.GridServer.exe
sleep 3
screen -S AssetServer -d -m mono OpenSim.Grid.AssetServer.exe
sleep 3
screen -S InventoryServer -d -m mono OpenSim.Grid.InventoryServer.exe
sleep 3
screen -S OpenSim -d -m mono OpenSim.exe -gridmode=true

===Startup and access servers===
./runsim.sh

If you have permission issues
chmod 755 runsim.sh

To see a list of the servers in screen:
screen -ls or screen -list

Output will look like the following:
There are screens on:
8419.OpenSim (Detached)
8403.InventoryServer (Detached)
8378.AssetServer (Detached)
8360.GridServer (Detached)
8347.UserServer (Detached)

To access server
screen -r 8419.OpenSim
screen -r 8403.InventoryServer
etc.

To exit screen, leaving server running, and to return to shell
ctrl-a d

===Shutdown Servers===
Either manually access each sceen
screen -r 8419.OpenSim
shutdown

Or use
killall mono
Or
for i in `ps afxu | grep -i "mono.*OpenSim" | grep -v grep | awk {'print $2'}`; do kill $i; done

Or to shut down each session clean, make a stop script, stopgrid.sh
#!/bin/bash
screen -S InventoryServer -X eval "stuff shutdown^M"
sleep 5
screen -S AssetServer -X eval "stuff shutdown^M"
sleep 5
screen -S GridServer -X eval "stuff shutdown^M"
sleep 5
screen -S UserServer -X eval "stuff shutdown^M"
This depends on the screen NAME to be the same as in the startup script described above!
--[[User:Suz|Suz]] 01:42, 18 May 2008 (PDT)

==Simulator Watchdog==
Watches the simulator process under Linux

Adding an entry to call a simple script to check the process table can restart regions that crash to the command line. Here [[User_talk:BlueWall]] is a script to accomplish this with a sample cron entry for one minute intervals. While it will not fix 100% of the crashes, it will get most cases, and help keep the grid healthy. If you have questions, you can usually find me on irc.freenode.net #opensim or #osgrid

--[[User:BlueWall|BlueWall]] 15:53, 19 June 2008 (PDT)

==Automate Updates==
===Linux (CentOS-5)===
This script will save your settings, grab the latest release of OpenSim, build OpenSim, and restore your settings to the new release. It creates the new release in a new directory allowing you to revert to the previous release by just changing the 'current' link to point to whichever release you want to run.

This script assumes you are using the SVN release number as the OpenSim directory with a link called 'current' pointing to it. So, you might, for example, have a directory called '/home/opensim/7577' and a link 'current -> 7577'. This script also uses a save folder for moving settings from the old release to the new.

You will also want to compare the 'OpenSim.ini' and the 'OpenSim.ini.example' by hand after running this update script. There are often changes in this file needed for the new release. The 'diff -bB' command helps a lot in this comparison.

<pre>
#!/bin/bash -x

CWD=`pwd`
MWD="/home/opensim" # Main Working Directory
SAVEDIR="$MWD/save" # Save Directory

if [ ! -d $SAVEDIR ]; then mkdir $SAVEDIR; fi
if [ ! -d $SAVEDIR/Regions ]; then mkdir $SAVEDIR/Regions; fi
if [ ! -d $SAVEDIR/DataSnapshot ]; then mkdir $SAVEDIR/DataSnapshot; fi
if [ ! -d $SAVEDIR/config-include ]; then mkdir $SAVEDIR/config-include; fi

cd $MWD

# save current settings
cp current/bin/*.xml $SAVEDIR
cp current/bin/*.db $SAVEDIR
cp current/bin/*.ini $SAVEDIR
cp current/bin/config-include/*.ini $SAVEDIR/config-include/
cp current/bin/Regions/*xml $SAVEDIR/Regions/
cp current/bin/DataSnapshot/*xml $SAVEDIR/DataSnapshot/

# Get fresh copy of OpenSim
REV=`svn info http://opensimulator.org/svn/opensim/trunk | fgrep Revision | awk '{print $2}'`
svn -r $REV co http://opensimulator.org/svn/opensim/trunk $REV
rm current
ln -s $REV current
cd current
./runprebuild.sh
nant
cd bin
# restore settings
if [ ! -d ./DataSnapshot ]; then mkdir ./DataSnapshot; fi
cp $SAVEDIR/*.xml .
cp $SAVEDIR/*.db .
cp $SAVEDIR/*.ini .
cp $SAVEDIR/config-include/* config-include/
cp $SAVEDIR/Regions/* Regions/
cp $SAVEDIR/DataSnapshot/* DataSnapshot/
cd $MWD
cd current
#
cd $CWD
</pre>

==Alternative methods==

Start/stop/restart OpenSim on Linux with [[Autorestart_With_Upstart|upstart]]

Automating Tasks

2009-07-01T14:49:17Z

Sean Heavy: /* Linux (CentOS-5) */

__NOTOC__
{{Template:Quicklinks}}

==Automate Grid Startup==
===Windows===
Create a batch file to start up your grid, e.g. startGrid.bat ;

@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i GTR 0 Echo There are %%i OpenSimulator processes running already. I quit! & Goto END

:: %PROGRAMFILES% expands to your normal application path
:: On an English system this is normally C:\Program Files
:: If you run a 64-bit Windows, with OpenSim as a 32-bit
:: application, substitute with %PROGRAMFILES(X86)%

Echo Starting User Server...
start "UserServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.UserServer.exe
sleep 5
Echo Starting Grid Server...
start "GridServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.GridServer.exe
sleep 5
Echo Starting Asset Server...
start "AssetServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.AssetServer.exe
sleep 5
Echo Starting Inventory Server...
start "InventoryServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.InventoryServer.exe
sleep 5
Echo Starting Messaging Server...
start "MessagingServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.MessagingServer.exe
sleep 5
Echo Starting Region Server...
start "RegionServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.exe -gridmode=true

:END

PS! Check that you have sleep command installed, I'm unsure if all Windows versions have that.<br>
If sleep is not installed one can use a localhost ping instead to replace "sleep 3".
PING -n 4 127.0.0.1>nul
This knowledgebase article describes how to add a batch file to startup of Windows (before logon).<br>
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/]<br>
Note that you have to start all applications and answer the configuration questions once before adding it to any startup.<br>
<br>
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

Or a more advanced batch that shut server processes down in the opposite order as recommended in the manual.
@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i EQU 0 Echo There are no OpenSimulator processes running. Nothing to stop.. & Goto END

Echo Stopping Region Server...
taskkill /T /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Region Server was not running! & Echo. & Goto n1
:r1
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Region Server stopped. & Echo. & Goto n1
Goto r1

:n1
Echo Stopping Messaging Server...
taskkill /T /IM OpenSim.Grid.MessagingServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Inventory Server was not running! & Echo. & Goto n2
:r2
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.MessagingServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo IMessaging Server stopped. & Echo. & Goto n2
Goto r2

:n2
Echo Stopping Inventory Server...
taskkill /T /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Inventory Server was not running! & Echo. & Goto n3
:r3
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Inventory Server stopped. & Echo. & Goto n3
Goto r3

:n3
Echo Stopping Asset Server...
taskkill /T /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Asset Server was not running! & Echo. & Goto n4
:r4
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Asset Server stopped. & Echo. & Goto n4
Goto r4

:n4
Echo Stopping Grid Server...
taskkill /T /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Grid Server was not running! & Echo. & Goto n5
:r5
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Grid Server stopped. & Echo. & Goto n5
Goto r5

:n5
Echo Stopping User Server...
taskkill /T /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo User Server was not running! & Echo. & Goto END
:r6
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo User Server stopped. & Echo. & Goto END
Goto r6

:END
(Batch edits, [[User:Suz|Suz]] 04:46, 27 May 2008 (PDT))

===Linux/Mac OS X===
You can use this [[startup_script_linux|startup script]]
* Use Screen Command
Use the screen command to automate startup
* Setup screen command and setup shell file
Linux install:
apt-get install screen (ubuntu)
pacman -S screen (archlinux)
Mac OS X: Download either MacPorts, http://www.macports.org/, or Fink, http://www.finkproject.org/ to download *nix packages
MacPorts
sudo port install screen
Fink
Need command line for Fink.
* Create file runsim.sh
#!/bin/sh
cd opensim/bin
sleep 3
screen -S UserServer -d -m mono OpenSim.Grid.UserServer.exe
sleep 3
screen -S GridServer -d -m mono OpenSim.Grid.GridServer.exe
sleep 3
screen -S AssetServer -d -m mono OpenSim.Grid.AssetServer.exe
sleep 3
screen -S InventoryServer -d -m mono OpenSim.Grid.InventoryServer.exe
sleep 3
screen -S OpenSim -d -m mono OpenSim.exe -gridmode=true

===Startup and access servers===
./runsim.sh

If you have permission issues
chmod 755 runsim.sh

To see a list of the servers in screen:
screen -ls or screen -list

Output will look like the following:
There are screens on:
8419.OpenSim (Detached)
8403.InventoryServer (Detached)
8378.AssetServer (Detached)
8360.GridServer (Detached)
8347.UserServer (Detached)

To access server
screen -r 8419.OpenSim
screen -r 8403.InventoryServer
etc.

To exit screen, leaving server running, and to return to shell
ctrl-a d

===Shutdown Servers===
Either manually access each sceen
screen -r 8419.OpenSim
shutdown

Or use
killall mono
Or
for i in `ps afxu | grep -i "mono.*OpenSim" | grep -v grep | awk {'print $2'}`; do kill $i; done

Or to shut down each session clean, make a stop script, stopgrid.sh
#!/bin/bash
screen -S InventoryServer -X eval "stuff shutdown^M"
sleep 5
screen -S AssetServer -X eval "stuff shutdown^M"
sleep 5
screen -S GridServer -X eval "stuff shutdown^M"
sleep 5
screen -S UserServer -X eval "stuff shutdown^M"
This depends on the screen NAME to be the same as in the startup script described above!
--[[User:Suz|Suz]] 01:42, 18 May 2008 (PDT)

==Simulator Watchdog==
Watches the simulator process under Linux

Adding an entry to call a simple script to check the process table can restart regions that crash to the command line. Here [[User_talk:BlueWall]] is a script to accomplish this with a sample cron entry for one minute intervals. While it will not fix 100% of the crashes, it will get most cases, and help keep the grid healthy. If you have questions, you can usually find me on irc.freenode.net #opensim or #osgrid

--[[User:BlueWall|BlueWall]] 15:53, 19 June 2008 (PDT)

==Automate Updates==
===Linux (CentOS-5)===
This script will save your settings, grab the latest release of OpenSim, build OpenSim, and restore your settings to the new release. It creates the new release in a new directory allowing you to revert to the previous release by just changing the 'current' link to point to whichever release you want to run.

This script assumes you are using the SVN release number as the OpenSim directory with a link called 'current' pointing to it. So, you might, for example, have a directory called '/home/opensim/7577' and a link 'current -> 7577'. This script also uses a save folder for moving settings from the old release to the new.

You will also want to compare the 'OpenSim.ini' and the 'OpenSim.ini.example' by hand after running this update script. There are often changes in this file needed for the new release. The 'diff -bB' command helps a lot in this comparison.

<pre>
#!/bin/bash -x

CWD=`pwd`
MWD="/home/opensim" # Main Working Directory
SAVEDIR="$MWD/save" # Save Directory

if [ ! -d $SAVEDIR ]; then mkdir $SAVEDIR; fi
if [ ! -d $SAVEDIR/Regions ]; then mkdir $SAVEDIR/Regions; fi
if [ ! -d $SAVEDIR/DataSnapshot ]; then mkdir $SAVEDIR/DataSnapshot; fi
if [ ! -d $SAVEDIR/config-include ]; then mkdir $SAVEDIR/config-include; fi

cd $MWD

# save current settings
cp current/bin/*.xml $SAVEDIR
cp current/bin/*.db $SAVEDIR
cp current/bin/*.ini $SAVEDIR
cp current/bin/config-include/*.ini $SAVEDIR/config-include/
cp current/bin/Regions/*xml $SAVEDIR/Regions/
cp current/bin/DataSnapshot/*xml $SAVEDIR/DataSnapshot/

# Get fresh copy of OpenSim
REV=`svn info http://opensimulator.org/svn/opensim/trunk | fgrep Revision | awk '{print $2}'`
svn -r $REV co http://opensimulator.org/svn/opensim/trunk $REV
rm current
ln -s $REV current
cd current
./runprebuild.sh
nant
cd bin
# restore settings
if [ ! -d ./DataSnapshot ]; then mkdir ./DataSnapshot; fi
cp $SAVEDIR/*.xml .
cp $SAVEDIR/*.db .
cp $SAVEDIR/*.ini .
cp $SAVEDIR/config-include/* config-include/
cp $SAVEDIR/Regions/* Regions/
cp $SAVEDIR/DataSnapshot/* DataSnapshot/
cd $MWD
cd current
cp -r $SAVEDIR/Encitra .
#
cd $CWD
</pre>

==Alternative methods==

Start/stop/restart OpenSim on Linux with [[Autorestart_With_Upstart|upstart]]

Automating Tasks

2008-12-12T18:44:28Z

Sean Heavy: Added 'Automate Updates'

==Automate Grid Startup==
===Windows===
Create a batch file to start up your grid, e.g. startGrid.bat ;

@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i GTR 0 Echo There are %%i OpenSimulator processes running already. I quit! & Goto END

:: %PROGRAMFILES% expands to your normal application path
:: On an English system this is normally C:\Program Files
:: If you run a 64-bit Windows, with OpenSim as a 32-bit
:: application, substitute with %PROGRAMFILES(X86)%

Echo Starting User Server...
start "UserServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.UserServer.exe
sleep 5
Echo Starting Grid Server...
start "GridServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.GridServer.exe
sleep 5
Echo Starting Asset Server...
start "AssetServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.AssetServer.exe
sleep 5
Echo Starting Inventory Server...
start "InventoryServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.Grid.InventoryServer.exe
sleep 5
Echo Starting Region Server...
start "RegionServer" /MIN /D "%PROGRAMFILES%\OpenSim" OpenSim.exe -gridmode=true

:END

PS! Check that you have sleep command installed, I'm unsure if all Windows versions have that.<br>
If sleep is not installed one can use a localhost ping instead to replace "sleep 3".
PING -n 4 127.0.0.1>nul
This knowledgebase article describes how to add a batch file to startup of Windows (before logon).<br>
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/]<br>
Note that you have to start all applications and answer the configuration questions once before adding it to any startup.<br>
<br>
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

Or a more advanced batch that shut server processes down in the opposite order as recommended in the manual.
@Echo OFF

For /F "Usebackq" %%i In (`Tasklist ^| Find /C "OpenSim"`) Do If /I %%i EQU 0 Echo There are no OpenSimulator processes running. Nothing to stop.. & Goto END

Echo Stopping Region Server...
taskkill /T /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Region Server was not running! & Echo. & Goto n1
:r1
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Region Server stopped. & Echo. & Goto n1
Goto r1

:n1
Echo Stopping Inventory Server...
taskkill /T /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Inventory Server was not running! & Echo. & Goto n2
:r2
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.InventoryServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Inventory Server stopped. & Echo. & Goto n2
Goto r2

:n2
Echo Stopping Asset Server...
taskkill /T /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Asset Server was not running! & Echo. & Goto n3
:r3
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.AssetServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Asset Server stopped. & Echo. & Goto n3
Goto r3

:n3
Echo Stopping Grid Server...
taskkill /T /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo Grid Server was not running! & Echo. & Goto n4
:r4
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.GridServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo Grid Server stopped. & Echo. & Goto n4
Goto r4

:n4
Echo Stopping User Server...
taskkill /T /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 128 Echo User Server was not running! & Echo. & Goto END
:r5
If ERRORLEVEL 1 taskkill /T /F /IM OpenSim.Grid.UserServer.exe > NUL 2>&1
If ERRORLEVEL 0 Echo User Server stopped. & Echo. & Goto END
Goto r5

:END
(Batch edits, [[User:Suz|Suz]] 04:46, 27 May 2008 (PDT))

===Linux/Mac OS X===
You can use this [[startup_script_linux|startup script]]
* Use Screen Command
Use the screen command to automate startup
* Setup screen command and setup shell file
Linux install:
apt-get install screen (ubuntu)
pacman -S screen (archlinux)
Mac OS X: Download either MacPorts, http://www.macports.org/, or Fink, http://www.finkproject.org/ to download *nix packages
MacPorts
sudo port install screen
Fink
Need command line for Fink.
* Create file runsim.sh
#!/bin/sh
cd opensim/bin
sleep 3
screen -S UserServer -d -m mono OpenSim.Grid.UserServer.exe
sleep 3
screen -S GridServer -d -m mono OpenSim.Grid.GridServer.exe
sleep 3
screen -S AssetServer -d -m mono OpenSim.Grid.AssetServer.exe
sleep 3
screen -S InventoryServer -d -m mono OpenSim.Grid.InventoryServer.exe
sleep 3
screen -S OpenSim -d -m mono OpenSim.exe -gridmode=true

===Startup and access servers===
./runsim.sh

If you have permission issues
chmod 755 runsim.sh

To see a list of the servers in screen:
screen -ls or screen -list

Output will look like the following:
There are screens on:
8419.OpenSim (Detached)
8403.InventoryServer (Detached)
8378.AssetServer (Detached)
8360.GridServer (Detached)
8347.UserServer (Detached)

To access server
screen -r 8419.OpenSim
screen -r 8403.InventoryServer
etc.

To exit screen, leaving server running, and to return to shell
ctrl-a d

===Shutdown Servers===
Either manually access each sceen
screen -r 8419.OpenSim
shutdown

Or use
killall mono
Or
for i in `ps afxu | grep -i "mono.*OpenSim" | grep -v grep | awk {'print $2'}`; do kill $i; done

Or to shut down each session clean, make a stop script, stopgrid.sh
#!/bin/bash
screen -S InventoryServer -X eval "stuff shutdown^M"
sleep 5
screen -S AssetServer -X eval "stuff shutdown^M"
sleep 5
screen -S GridServer -X eval "stuff shutdown^M"
sleep 5
screen -S UserServer -X eval "stuff shutdown^M"
This depends on the screen NAME to be the same as in the startup script described above!
--[[User:Suz|Suz]] 01:42, 18 May 2008 (PDT)

==Simulator Watchdog==
Watches the simulator process under Linux

Adding an entry to call a simple script to check the process table can restart regions that crash to the command line. Here [[User_talk:BlueWall]] is a script to accomplish this with a sample cron entry for one minute intervals. While it will not fix 100% of the crashes, it will get most cases, and help keep the grid healthy. If you have questions, you can usually find me on irc.freenode.net #opensim or #osgrid

--[[User:BlueWall|BlueWall]] 15:53, 19 June 2008 (PDT)

==Automate Updates==
===Linux (CentOS-5)===
This script will save your settings, grab the latest release of OpenSim, build OpenSim, and restore your settings to the new release. It creates the new release in a new directory allowing you to revert to the previous release by just changing the 'current' link to point to whichever release you want to run.

This script assumes you are using the SVN release number as the OpenSim directory with a link called 'current' pointing to it. So, you might, for example, have a directory called '/home/opensim/7577' and a link 'current -> 7577'. This script also uses a save folder for moving settings from the old release to the new.

You will also want to compare the 'OpenSim.ini' and the 'OpenSim.ini.example' by hand after running this update script. There are often changes in this file needed for the new release. The 'diff -bB' command helps a lot in this comparison.

<pre>
#!/bin/bash -x

CWD=`pwd`
MWD="/home/opensim" # Main Working Directory (change appropriately)
SAVEDIR="$MWD/save" # Save Directory

if [ ! -d $SAVEDIR ]; then mkdir $SAVEDIR; fi
if [ ! -d $SAVEDIR/Regions ]; then mkdir $SAVEDIR/Regions; fi
if [ ! -d $SAVEDIR/DataSnapshot ]; then mkdir $SAVEDIR/DataSnapshot; fi

cd $MWD

# Save current settings
cp current/bin/estate_settings.xml $SAVEDIR
cp current/bin/*.db $SAVEDIR
cp current/bin/ImageService.dll $SAVEDIR
cp current/bin/OpenSim.ini $SAVEDIR
cp current/bin/LaunchSLClient.ini $SAVEDIR
cp current/bin/Regions/*xml $SAVEDIR/Regions/
cp current/bin/DataSnapshot/*xml $SAVEDIR/DataSnapshot/

# Get fresh copy of OpenSim
REV=`svn info http://opensimulator.org/svn/opensim/trunk | fgrep Revision | awk '{print $2}'`
svn -r $REV co http://opensimulator.org/svn/opensim/trunk $REV
# Repoint the 'current' link to the new release
rm current
ln -s $REV current
cd current
# Build OpenSim
./runprebuild.sh
nant
cd bin

# Restore settings
if ![ -d ./DataSnapshot ]; then mkdir ./DataSnapshot; fi
cp $SAVEDIR/estate_settings.xml .
cp $SAVEDIR/*.db .
cp $SAVEDIR/ImageService.dll .
cp $SAVEDIR/OpenSim.ini .
cp $SAVEDIR/LaunchSLClient.ini .
cp $SAVEDIR/Regions/*.xml Regions/
cp $SAVEDIR/DataSnapshot/*.xml DataSnapshot/

cd $CWD
</pre>

RemoteAdmin

2008-10-19T19:22:20Z

Sean Heavy: /* RemoteAdmin Commands */

<div style="background-color:#ffa0a0; padding:15px">
<b>Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.</b>
</div>

== 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:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# 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 [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
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_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// 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);
?>
</source>

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.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
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);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname user_lastname user_password start_region_x start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Execute the Save XML command</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2008-10-19T19:19:36Z

Sean Heavy: /* RemoteAdmin Commands */

<div style="background-color:#ffa0a0; padding:15px">
<b>Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.</b>
</div>

== 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:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# 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 [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
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_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// 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);
?>
</source>

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.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
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);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname user_lastname user_password start_region_x start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Load a saved XML file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2008-10-11T15:43:45Z

Sean Heavy: /* RemoteAdmin Commands */

<div style="background-color:#ffa0a0; padding:15px">
<b>Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.</b>
</div>

== 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:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# 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 [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
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_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// 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);
?>
</source>

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.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
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);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_exists_user| admin_exists_user]]</td>
<td></td>
<td>Check whether a certain user account exists</td>
<td>user_firstname, user_lastname</td>
</tr>
<tr>
<td>[[remoteadmin:admin_update_user| admin_update_user]]</td>
<td></td>
<td>Update the password/home of a user account</td>
<td>user_firstname user_lastname user_password start_region_x start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename</td>
</tr>
<tr>
<td>[[remoteadmin:admin_save_xml| admin_save_xml]]</td>
<td></td>
<td>Load a saved XML file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_oar| admin_load_oar]]</td>
<td></td>
<td>Load a saved OAR file into a region</td>
<td>filename region_uuid (or region_name)</td>
</tr>
<tr>
<td>[[remoteadmin:admin_region_query| admin_region_query]]</td>
<td></td>
<td>Query the 'health' of a region</td>
<td>region_uuid or region_name</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]

RemoteAdmin

2008-10-11T15:24:11Z

Sean Heavy: /* RemoteAdmin Commands */

<div style="background-color:#ffa0a0; padding:15px">
<b>Caution ! The RemoteAdmin feature is unsecured at this time. For testing uses only.</b>
</div>

== 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:

[RemoteAdmin]
enabled = true
access_password = secret

=== Example in Python ===
# Author : DrScofield
# Source : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/
# License : BSD License

#!/usr/bin/python
import xmlrpclib

# XML-RPC URL (http_listener_port)
gridServerURL = ‘http://127.0.0.1:9000′

# 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 [http://lab.newworldgrid.com/index.php/RemoteAdmin_Executable RemoteAdmin Executable webpage]

=== Example in PHP ===

This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
<source lang=php>
<?php

// Author : Olish Newman
// Source : http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass
// Licence : BSD License

// Including the RemoteAdmin PHP class. It can be downloaded from the link above.
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_broadcast
$parameters = array('message' => 'the answer is 42');
$myRemoteAdmin->SendCommand('admin_broadcast', $parameters);

// Invoke admin_shutdown (example for use without parameters)
$myRemoteAdmin->SendCommand('admin_shutdown');

// 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);
?>
</source>

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.
<source lang="php">
//This is the slightly modified RPC-class of the BSD-licensed WiXTD webportal
<?php
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);
curl_close($ch);
return xmlrpc_decode($result);
}
}
?>
</source>

== RemoteAdmin Commands ==
<table border="1" cellspacing="0" cellpadding="4">
<tr>
<th>Name</th>
<th>Status</th>
<th>Description</th>
<th>Parameters</th>
</tr>
<tr>
<td>[[remoteadmin:admin_create_region | admin_create_region]]</td>
<td></td>
<td>Create a new region</td>
<td>region_name, region_master_first,
region_master_last, region_master_password, listen_ip, external_address</td>
</tr>
<tr>
<td>[[remoteadmin:admin_delete_region | admin_delete_region]]</td>
<td></td>
<td>Delete a region</td>
<td>region_name</td>
</tr>
<tr>
<td>[[remoteadmin:admin_shutdown | admin_shutdown]]</td>
<td></td>
<td>Shut down the simulator</td>
<td>''No parameter needed''</td>
</tr>
<tr>
<td>[[remoteadmin:admin_broadcast| admin_broadcast]]</td>
<td></td>
<td>Send a general alert</td>
<td>message</td>
</tr>
<tr>
<td>[[remoteadmin:admin_restart| admin_restart]]</td>
<td></td>
<td>Restart Region</td>
<td>regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_heightmap| admin_load_heightmap]]</td>
<td></td>
<td>Load Height Map...</td>
<td>filename, regionid</td>
</tr>
<tr>
<td>[[remoteadmin:admin_create_user| admin_create_user]]</td>
<td></td>
<td>Create a new user</td>
<td>user_firstname, user_lastname, user_password,
start_region_x, start_region_y</td>
</tr>
<tr>
<td>[[remoteadmin:admin_load_xml| admin_load_xml]]</td>
<td></td>
<td>Execute the Load XML command</td>
<td>filename</td>
</tr>
</table>

== Credits ==
Thanks to DrScofield for the Python Script
Sources : http://xyzzyxyzzy.net/2008/01/23/using-pythons-xmlrpclib-with-opensim/

[[Category:Development]]