RemoteAdmin:admin load oar

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Robot: Cosmetic changes)
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name)
Line 93: Line 93:
= See Also =
= See Also =
* [[OpenSim Archives|How to use OpenSim Archives (OAR)]]
* [[OpenSim Archives|How to use OpenSimulator Archives (OAR)]]
* [[OAR Format 0.1]]
* [[OAR Format 0.1]]
* [[OAR Format 0.2]]
* [[OAR Format 0.2]]

Revision as of 23:56, 3 March 2012

admin_load_oar remotely allows to load a saved OAR file into a region


Enabling admin_load_oar

If not all functions are enabled, use admin_load_oar to enable the function in the [RemoteAdmin] section

enabled_methods = admin_load_oar,...


Required Parameters

These parameters are required

parameter Description Values
region_name Name of the new region, optionaly region_uuid
filename file name

Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
region_id region uuid, optional region_name
merge merge oar with the existing region objects "true"
skip-assets skip loading assets to region objects "true"

Returned Parameters

Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
loaded true when successfully loaded file true, false

Error messages

No error messages




// Including the RemoteAdmin PHP class.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 9000, 'secret');
// Invoke admin_load_oar (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'filename' => 'my_xml_backup.oar');
$myRemoteAdmin->SendCommand('admin_load_oar', $parameters);

See Also

RemoteAdmin RemoteAdmin:Commands

Personal tools
About This Wiki