RemoteAdmin:admin load oar
From OpenSimulator
(Difference between revisions)
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name) |
(→PHP) |
||
| Line 76: | Line 76: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
Revision as of 16:02, 7 November 2013
admin_load_oar remotely allows to load a saved OAR file into a region
Contents |
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,...
Parameters
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
Notes
Example
PHP
This example needs the RemoteAdmin PHP Class file available here.
<?php // Including the RemoteAdmin PHP class. include('RemoteAdmin.php'); // Instantiate the class with parameters identical to the Python example above $myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); // Invoke admin_load_oar (multiple parameters) $parameters = array('region_name' => 'My Plaza', 'filename' => 'my_xml_backup.oar'); $myRemoteAdmin->SendCommand('admin_load_oar', $parameters); ?>
