OpenSimulator - User contributions [en]

Server Commands

2018-10-16T17:37:46Z

Dev Random: /* Adding "terrain modify" to list of Terrain 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]].

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

2015-11-11T18:35:53Z

Dev Random: /* Terrain 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]].

== 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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain modify - Performs terrain modifications in a bounded area in the heightmap.

=== 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 - Enable 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.
* 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)

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

2015-05-07T19:31:27Z

Dev Random: /* Details of Terrain Module 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]].

== 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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2015-05-06T21:13:53Z

Dev Random: /* terrain modify */

{{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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

== 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 feature ====
OpenSimulator 0.8.1 onwards. Adds a specified feature to the terrain heightmap.

*Deprecated - see terrain modify

General command usage:
:''terrain feature <name> <arg1> <arg2> …''

Implemented Features:
* rectangle
:Parameters
:* height (Float)
: elevation for the feature
:* x-origin (Integer)
: minimum x-coordinate for bounding box
:* y-origin (Integer)
: minimum y-coordinate for bounding box
:* x-size (Integer)
: size in x-direction for bounding box
:* y-size (Integer)
: size in y-direction for bounding box (will use x-size, if not specified)

==== 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)
:* 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.

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2015-05-06T21:06:14Z

Dev Random: /* Details of Terrain Module 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]].

== 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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

== 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 feature ====
OpenSimulator 0.8.1 onwards. Adds a specified feature to the terrain heightmap.

*Deprecated - see terrain modify

General command usage:
:''terrain feature <name> <arg1> <arg2> …''

Implemented Features:
* rectangle
:Parameters
:* height (Float)
: elevation for the feature
:* x-origin (Integer)
: minimum x-coordinate for bounding box
:* y-origin (Integer)
: minimum y-coordinate for bounding box
:* x-size (Integer)
: size in x-direction for bounding box
:* y-size (Integer)
: size in y-direction for bounding box (will use x-size, if not specified)

==== 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)
:* 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]

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2015-05-06T20:47:16Z

Dev Random: /* terrain feature */

{{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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

== 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 feature ====
OpenSimulator 0.8.1 onwards. Adds a specified feature to the terrain heightmap.

Deprecated - see terrain modify

General command usage:
:''terrain feature <name> <arg1> <arg2> …''

Implemented Features:
* rectangle
:Parameters
:* height (Float)
: elevation for the feature
:* x-origin (Integer)
: minimum x-coordinate for bounding box
:* y-origin (Integer)
: minimum y-coordinate for bounding box
:* x-size (Integer)
: size in x-direction for bounding box
:* y-size (Integer)
: size in y-direction for bounding box (will use x-size, if not specified)

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2014-11-24T14:06:33Z

Dev Random: /* terrain feature */

{{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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

== 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 feature ====
Adds a specified feature to the terrain heightmap.

General command usage:
:''terrain feature <name> <arg1> <arg2> …''

Implemented Features:
* rectangle
:Parameters
:* height (Float)
: elevation for the feature
:* x-origin (Integer)
: minimum x-coordinate for bounding box
:* y-origin (Integer)
: minimum y-coordinate for bounding box
:* x-size (Integer)
: size in x-direction for bounding box
:* y-size (Integer)
: size in y-direction for bounding box (will use x-size, if not specified)

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2014-11-24T14:05:35Z

Dev Random: /* Details of Terrain Module 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]].

== 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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

== 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 feature ====
Adds a specified feature to the terrain heightmap.

General command usage:
:''terrain feature <name> <arg1> <arg2> …''

Implemented Features:
* rectangle
:Parameters
:* height (Float)
: elevation for the feature
:* x-origin (Integer)
: minimum x-coordinate for bounding box
:* y-origin (Integer)
: minimum y-coordinate for bounding box
:* x-size (Integer)
: size in x-direction for bounding box
:* y_size (Integer)
: size in y-direction for bounding box (will use x-size, if not specified)

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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

2014-11-24T13:35:23Z

Dev Random: /* Terrain 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]].

== 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])
* 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

=== 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
* 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 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 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.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect.
* terrain feature - Creates a specified feature in the terrain heightmap.

=== 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 - Enable 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.
* 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)

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

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

'''Important Note'''

Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.

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]]

OsForceBreakAllLinks

2014-06-29T00:03:37Z

Dev Random: osForceBreakLink and osForceBreakAllLinks were both linked to same page. Fixed osForceBreakLink, and added this page.

{{osslfunc
|threat_level=VeryLow
|function_syntax=osForceBreakAllLinks()
|description=* Identical to llBreakAllLinks() except that it doesn't require the link permission to be granted. Present in 0.8 and later.
}}

OsForceBreakLink

2014-06-28T23:54:30Z

Dev Random:

{{osslfunc
|threat_level=VeryLow
|function_syntax=osForceBreakLink(integer link)
|description=* Identical to llBreakLink(integer link) except that it doesn't require the link permission to be granted. Present in 0.8 and later.
}}

OsForceCreateLink

2014-06-28T23:52:38Z

Dev Random:

{{osslfunc
|threat_level=VeryLow
|function_syntax=osForceCreateLink(key target, int parent)
|description=* Idential to llCreateLink() except that it doesn't require the link permission to be granted. Present in 0.8 and later.
}}

OsGetPhysicsEngineType

2014-06-27T22:18:09Z

Dev Random:

{{osslfunc
|threat_level=High
|function_syntax=string osGetPhysicsEngineType()
|ossl_example=<source lang = "lsl">
// ----------------------------------------------------------------
// Example / Sample Script to show function use.
//
// Script Title: osGetPhysicsEngineType.lsl
// Script Author:
// Threat Level: High
// Script Source: http://opensimulator.org/wiki/OsGetPhysicsEngineType
//
// Notes: See Script Source reference for more detailed information
// This sample is full opensource and available to use as you see fit and desire.
// Threat Levels only apply to OSSL & AA Functions
// See http://opensimulator.org/wiki/Threat_level
// ================================================================
// Inworld Script Line: string osGetPhysicsEngineType();
//
// Example of osGetPhysicsEngineType()
//
default
{
state_entry() // display @ start
{
llSay(0, "Touch me to get the physics engine type using osGetPhysicsEngineType");
}
touch_end(integer num) // Tell toucher our version
{
llInstantMessage(llDetectedKey(0), "Physics engine type: "+osGetPhysicsEngineType());
}
}
</source>
|description=This function returns a string containing the name of the Physics Engine.
|
}}
Notes:
This function does not throw an exception if the threat level is not high enough. If 'os' functions are enabled, this function will return an empty string if the threat level is not met. This allows vehicle scripts to always check this and not worry about exceptions.

The value returned is the name of the physics engine specified in the OpenSim.ini file ("physics = XXX"). It is usually either "OpenDynamicsEngine" or "BulletSim".

Database Settings

2014-05-22T11:38:48Z

Dev Random: /* Installing MySQL Server */

{{Quicklinks}}

If you want to quick know the walkthrough for database setup, see [[#Quick Setup]].

'''TODO: This page needs to be improved for setting up database usage in Robust, though the config parameters are identical to the StandaloneCommon.ini/GridCommon.ini files.

= Structure =

On OpenSimulator 0.7.1 and later, you need to set '''StorageProvider''' and '''ConnectionString''' so that OpenSimulator can connect to a database. Usually you'll need to edit '''StandaloneCommon.ini''' for standalone or '''GridCommon.ini''' for grid mode.

In those files, you'll find the [DatabaseService] section. This is where the database is configured. There are number of entries - the only ones that should be uncommented (by removing the beginning semi-colon) are those which apply to the database that you want. All the others must be commented out (by adding a semi-colon to the front of the line).

==Examples==

===MySQL===

For MySQL you will uncomment the required lines and configure as appropriate. For instance, the lines

<pre>
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=opensimdb;User ID=opensim;Password=h0tgrits;Old Guids=true;"
</pre>

In this case, it will connect to a MySQL database called opensimdb on the same machine running the simulator (localhost). The user connecting is opensim with the password h0tgrits.

===PostgreSQL===

For PostgreSQL you will uncomment the required lines and configure as appropriate. For instance, the lines

<pre>
StorageProvider = "OpenSim.Data.PGSQL.dll"
ConnectionString = "Data Source=localhost;Database=opensimdb;User ID=opensim;Password=h0tgrits;Port=5432;"
</pre>

In this case, it will connect to a PostgreSQL database called opensimdb on the same machine running the simulator (localhost). The user connecting is opensim with the password h0tgrits. If you changed the port number on PostgreSQL installation, you may add to connection string "Port=5432" where 5432 you may change to the installed port.

* PostgreSQL database module isn't in 0.7.6 release. It is still on the bleeding edge source code.

===SQLite===

SQLite is slightly different. Instead you would uncomment (or leave uncommented) the line.

Or, you can include another ini files. You'll find a line like that:
<pre>
Include-Storage = "config-include/storage/SQLiteStandalone.ini";
</pre>

This will go on to read config-include/storage/SQLiteStandalone.ini after reading this ini file. If you open SQLiteStandalone.ini file, you'll find StrageProvider and ConnectionString lines in each sections. As SQLite does not require users or passwords to be setup, there is no further configuration to be done unless you want sqlite to use different filenames for its databases.

===MSSQL===

'''NOTE: There had been another way to connect to MSSQL database, which was using "mssql_connection.ini" in bin/ directory. On OpenSimulator 0.7.1 or later, it will NOT be read even if you set it properly. Use ConnectionString in *Common.ini instead. For more specific details, see the section [[#MSSQL]].'''

== Database Parameters ==

{|border="1" cellspacing="0"
|- style="background-color:#DDDDFF;"
| Parameter
| Possible Values
| Description

|-
| StorageProvider
| "OpenSim.Data.SQLite.dll" (SQLite)<br />"OpenSim.Data.MySQL.dll" (MySQL)<br />"OpenSim.Data.PGSQL.dll" (PostgreSQL)<br />"OpenSim.Data.MSSQL.dll" (Microsoft SQL Server)<br />"OpenSim.Data.Null.dll" (disable persistence)
| The name of the storage provider modules, which can be found in bin/ folder. The three above are which OpenSimulator officially support (though MSSQL is partially). If you choose "OpenSim.Data.Null.dll", OpenSimulator will keep all data in its memory instead of using DBMS.

|-
| ConnectionString
| See [[#ConnectionString Syntax]]
| A string that OpenSimulator specifies information about a data source. Usually it may include the hostname or ip addresses of database server, database service names, username, schema name and password. The syntax varies between databases.

|-
| EstateConnectionString
| See [[#ConnectionString Syntax]]
| The same as ConnectionString, but it will be used only for Estate Service. (optional)
|}

== ConnectionString Syntax ==

=== MySQL ===

''Data Source=[1];Database=[2];User ID=[3];Password=[4];Old Guids=true;''

* [1] The hostname or ip address of database server
* [2] Database name
* [3] Username for the database above
* [4] Password for the user above

Example: If you have created the database "opensim" in localhost, and then created
the user "opensimuser" and its password is "opensimpassword", it will be:
<pre>
ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensimuser;Password=opensimpassword;Old Guids=true;"
</pre>

=== PostgreSQL ===

''Data Source=[1];Database=[2];User ID=[3];Password=[4];Port=[5]''

* [1] The hostname or ip address of database server
* [2] Database name
* [3] Username for the database above
* [4] Password for the user above
* [5] Port number for the server (default=5432)

Example: If you have created the database "opensim" in localhost, and then created
the user "opensimuser" and its password is "opensimpassword", and the server port number is 5435 it will be:
<pre>
ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensimuser;Password=opensimpassword;Port=5435"
</pre>

=== SQLite ===

''URI=file:[1],version=3,UseUTF16Encoding=True;''

* [1] The path to the database file (relative to the bin/ directory - If there is no file on this path, it will be created automatically)

Example: If you want to create the database for Inventory Service in the directory "bin/db", it will be:
<pre>
ConnectionString = "URI=file:db/inventory.db,version=3,UseUTF16Encoding=True"
</pre>

=== MSSQL ===

''Server=[1];Database=[2];User Id=[3]; password=[4];''

* [1] "servername\instance name" - You can see this string in SQL Server Managerment Studio login dialog(Server:).
* [2] Database name
* [3] Username for the database above
* [4] Password for the user above

Example: If you have installed Microsoft SQL Server Express Edition with default settings on your local machine
, created the database "opensim" in localhost, and then created the user "opensimuser" and its password is "opensimpassword", it will be:
<pre>
ConnectionString = "Server=localhost\SQLEXPRESS;Database=opensim;User Id=opensimuser; password=opensimpassword;"
</pre>

== Using different database settings for different services ==

'''Note: This is extremely advanced configuration and needs to be updated for ROBUST configuration as well as standalone (which is what is implied here).'''

Currently there are several services in OpenSimulator.
* [InventoryService]
* [AssetService]
* [AvatarService]
* [AuthenticationService]
* [UserAccountService]
* [GridUserService]
* [FriendsService]
* [EstateDataStore]
* [SimulationDataStore]
* [PresenceService]
* [AuthorizationService]
* [GridService]

You can use a different database for each service by overriding the StorageProvider and ConnectionString properties as we saw in the general [DatabaseService] section above. For instance, if you want to use MySQL 'opensim' in general but MySQL 'opensim2' for Inventory Service and MSSQL for Authentication Service, you'll need to write in StandaloneCommon.ini something like:

<pre>
[DatabaseService]
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensim;Password=***;Old Guids=true;"
...
[InventoryService]
ConnectionString = "Data Source=localhost;Database=opensim2;User ID=opensim;Password=***;Old Guids=true;"
...
[AuthenticationService]
...(another parameters for authentication service)...
StorageProvider = "OpenSim.Data.MSSQL.dll"
ConnectionString = "Data Source=(local);Database=opensim;User=opensim;password=********;"
</pre>

If OpenSimulator can't find StorageProvider or ConnectionString in each service's section, it will use those in [DatabaseService] section. If OpenSimulator find each or them, it will use the parameter in each service's section. Thus, then the settings in these sections override those in [DatabaseService] section.

In this case, Inventory Service will:
* read [DatabaseService]StorageProvider
* read [DatabaseService]ConnectionString -> read [InventoryService]ConnectionString and override

Authentication Service will:
* read [DatabaseService]StorageProvider -> read [AuthenticationService]StorageProvider and override
* read [DatabaseService]ConnectionString -> read [AuthenticationService]ConnectionString and override

Note: SQLite and MSSQL providers don't support some services.

Note: For Estate Service, there is another parameter EstateConnectionString in [DatabaseService]. It is the middle priority between [DatabaseService] and [EstateDataStore] ConnectionStrings. OpenSimulator reads ConnectionString in [DatabaseService] section first, next EstateConnectionString, finally ConnectionString in [EstateDataService] section and overrides.

= Quick Setup =

== SQLite Walkthrough ==

By default, OpenSimulator will automatically create its SQLite database files(*.db) in bin/ directory. You don't need to do anything generally.
If you want to create the database files in another directory, you can change by editing ConnectionString in bin/config-include/storage/SQLiteStandalone.ini included by config-include/*Commons.ini. See [[#SQLite]] section for the detailed syntax.

== MySQL Walkthrough ==

=== Download ===
Download and install "MySQL Community Server" from [http://dev.mysql.com/downloads/mysql/ MySQL Downloads Page]. On Linux, you can even fetch "mysql-server" or "mysql-community-server" with your native package manager.

=== Installing MySQL Server ===
On Windows:
Download MSI and run it. Select "Typical". After installation, it will launch "MySQL Server Instance Configuration Wizard". Select "Standard Configuration". In the next screen, you might be happy later if you check "Include Bin Directory in Windows PATH". In the next screen, provide mysql root password. It will complete settings for mysql and startup its service automatically. See [http://dev.mysql.com/doc/refman/5.5/en/windows-installation.html MySQL Documentation] for more details.

On Mac OS X:
Download DMG package and install it normally. After install the server package, you can even install MySQL Startup Item if you want MySQL to start automatically during system startup. After that, startup your MySQL by following commands. See [http://dev.mysql.com/doc/refman/5.5/en/macosx-installation.html MySQL Documentation] for more details.

MySQL must be configured to use UTF8 as its default character set. In the config file /etc/my.cnf (Linux) or my.ini (Windows), add these settings:

<pre>
[mysqld]
character-set-server=utf8

[client]
default-character-set=utf8
</pre>

And it's ready to run.

<pre>
$ cd /usr/local/mysql
$ sudo ./bin/mysqld_safe
(enter your password, if necessary)
(press ctrl-Z)
$ bg
(press ctrl-D or enter "exit" to exit the shell)
</pre>

On Linux:
RPM install the downloaded package or install "mysql-server" or "mysql-community-server" with your package manager. For more instructions for installation, see [http://dev.mysql.com/doc/refman/5.5/en/linux-installation.html MySQL Documentation]. After that, startup your MySQL with following command.
<pre>
$ /etc/init.d/mysqld start
</pre>

If you want to startup MySQL server automatically, see [http://dev.mysql.com/doc/refman/5.5/en/automatic-start.html 2.10.1.2. Starting and Stopping MySQL Automatically in MySQL 5.5 Reference Manual].

=== Creating MySQL Database ===
Now you can configure your MySQL with the command line tools.
<pre>
$ mysql -u root --password
(enter your password, or if you haven't set password for MySQL server, type "mysql -u root" instead)
</pre>
You can even use MySQL Command Line Client on Start menu on Windows. After login, create user and database for OpenSimulator.
<pre>
mysql> create database opensim;
mysql> use opensim;
mysql> create user 'opensimuser'@'localhost' identified by 'opensimpassword';
mysql> grant all on opensim.* to 'opensimuser'@'localhost';
mysql> quit
</pre>

=== Configuring OpenSimulator ===
Open StandaloneCommon.ini or GridCommon.ini with your editor. First, comment-out the line for SQLite.
<pre>
; SQLite
;Include-Storage = "config-include/storage/SQLiteStandalone.ini";
</pre>
After that, uncomment StorageProvider and ConnectionString property lines in [DatabaseService] section and change the line like that:
<pre>
; MySql
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensimuser;Password=opensimpassword;Old Guids=true;"
</pre>
Note that "Data Source=localhost;" actually specifies a TCP socket. If your MySQL server is set up to refuse remote connections (i.e. with skip-networking enabled) you'll need to replace "localhost" with the path to MySQL's UNIX socket.
<pre>
ConnectionString = "Data Source=/var/run/mysqld/mysqld.lock;Database=opensim;User ID=opensimuser;Password=opensimpassword;Old Guids=true;"
</pre>
You can find the path to the socket that your MySQL server is using with mysqladmin.
<pre>
$ mysqladmin -p -u root version
</pre>

Save and start OpenSimulator. It will access to your new MySQL database instead of the default SQLite databases.

== PostgreSQL Walkthrough ==

=== Download ===
Download and install PostgreSQL server from [http://www.postgresql.org/download/ PostgreSQL Downloads Page]. On Linux, you can even fetch "postgresql" with your native package manager.

== MSSQL Walkthrough ==

=== Download ===
To download Microsoft SQL Server 2008 Express edition: [http://www.microsoft.com/Sqlserver/2008/en/us/express.aspx]
Make sure you download Microsoft SQL Server 2008 Express with Tools ([http://www.microsoft.com/downloads/details.aspx?FamilyId=7522A683-4CB2-454E-B908-E805E9BD4E28]) since you will likely want a nice tool to work with your database. If you already downloaded Microsoft SQL Server before, skip to "Checking Instance Configurations" step.

=== Installing Microsoft SQL Server ===
Double-click the downloaded executable and select click Installation and "New SQL Server stand-alone installation or add features to an existing installation". It will start installation process, you only need to click "OK", "Next" or "Install" until you come across the "Feature Selection". In this screen, you need to check "Database Engine Service" and "Management Tools - Basic", then click "Next". In next screen "Instance Configuration", check what is filled in "Named instance:" property - you will later use this later. For example, for default Express Edition, you'll see "SQLEXPRESS". Click "Next". Then go on default until you reach "Server Configuration". In this screen, fill in Account Name and Password field with you windows login name and password. In next "Database Engine Configuration" screen, you will need to enable '''Mixed Mode'''. After that provide password, click "Add Current User", and then continue clicking "Next" or "OK" until it completes the installation process. After that, you'll find the entry "SQL Server Managerment Studio" in "Microsoft SQL Server 2008" on the Windows Start menu. Open it and click "connect" to connect to your instance.

=== Checking Instance Configurations ===
Right-click on your database server in Management Studio and select Properties, then go to the Security tab and select '''SQL Server and Windows Authentication mode''', click OK. If you have already installed SQL Server before and you find "Windows Authentication mode" enabled instead, change it.

=== Creating User for Database ===
Expand the Security node, then right-click the Logins node. Select "New Login..." to open "Login - New" dialog. In this screen, fill "Login name" with the string whatever you like, select "SQL Server authentication", give it a strong password, uncheck "User must change password at next login", and click "OK". In this tutorial, we'll assume you have typed "opensimuser" for Login name, and "opensimpassword" for password.

=== Creating Database ===
Right-click on the Databases node and and select "New Database..." to open "New Database" dialog. In "Database name" field, you provide any names for the new database, which we'll assume is "opensim". In "Owner" field, provide the name of newly created database user("opensimuser" in this tutorial). Accept all defaults and click "OK".

=== Configuring OpenSimulator ===
Open StandaloneCommon.ini or GridCommon.ini with your editor. First, comment-out the line for SQLite.
<pre>
; SQLite
;Include-Storage = "config-include/storage/SQLiteStandalone.ini";
</pre>
After that, add these line in [DatabaseService] section. As of OpenSimulator 0.7.1, there is no sample configurations for MSSQL(Microsoft SQL Server), so you need to add them by yourself.
<pre>
; MSSQL
StorageProvider = "OpenSim.Data.MSSQL.dll"
ConnectionString = "Server=localhost\SQLEXPRESS;Database=opensim;User Id=opensimuser; password=opensimpassword;"
</pre>

Save and start OpenSimulator. It will access to your new SQL Server database instead of the default SQLite databases.

= Additional Settings =
== MySQL ==
MySQL's own configuration is handled in its my.ini file (found in "C:\ProgramData\MySQL\MySQL Server x.y" on recent versions of MySQL on Windows) or my.cnf file (found at /etc/mysql/my.cnf on Ubuntu Linux systems, for instance).

In general, the default configuration is fine for OpenSimulator. However, you may want to check the max_allowed_packet size. Very large objects, such as linksets with a very large number of parts or large mesh objects may generate OpenSimulator assets that exceed the default BLOB size that MySQL can store. On Ubuntu the max_allowed_packet size is 16M, which should be fine. On Windows MySQL it can be set larger. In early versions of MySQL [http://dev.mysql.com/doc/refman/5.1/en/packet-too-large.html the default is 1M] which may be too small. Windows 5.6 MySQL default is 4M.

Notes: [http://osgrid.org OSGrid] maximum asset size is reported as 45MB at May 2013. [http://vue.ed.ac.uk/openvue/ Openvue] grid maximum asset size is reported as 16MB as at May 2013.

To change this setting, one would add a line like the following in the [mysqld] section of the my.ini or my.cnf file. E.g.,

max_allowed_packet = 16M

[[Category:Database]]

Estate Support

2014-04-13T14:17:23Z

Dev Random: /* Introduction */

{{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.

= Tasks =

'''TODO: Need to add more tasks as necessary:
* create estate
* assign region to estate
* list all estates in database
* delete estate
'''

== Show information about an estate ==

Estate information can be shown through the "estate show" command.
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 show

Another option (perhaps the usual) is to login to the OpenSimulator installation with a viewer and look at the "Covenant" tab of the "About Land" box.

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;

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

= 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

2014-04-13T14:15:58Z

Dev Random: /* Tasks */

{{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, change owner, etc.) must be added in the future. At the moment, the only way to do this is by manipulating the region database directly.

= Tasks =

'''TODO: Need to add more tasks as necessary:
* create estate
* assign region to estate
* list all estates in database
* delete estate
'''

== Show information about an estate ==

Estate information can be shown through the "estate show" command.
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 show

Another option (perhaps the usual) is to login to the OpenSimulator installation with a viewer and look at the "Covenant" tab of the "About Land" box.

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;

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

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