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.

General Server Commands

General

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

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. (#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.

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

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

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

Grid Service

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.

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.