RemoteAdmin:admin load oar

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''admin_load_oar''' remotely allows to load oar files to a region === Enabling admin_load_oar === If not all functions are enabled, use admin_load_oar to enable the function i...")
 
m
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''admin_load_oar''' remotely allows to load oar files to a region
+
'''admin_load_oar''' remotely allows to load a saved OAR file into a region  
  
  
Line 37: Line 37:
 
! Values
 
! Values
 
|-
 
|-
| ''region_uuid''
+
| ''region_id''
 
| region uuid, optional region_name
 
| region uuid, optional region_name
 
|
 
|
Line 49: Line 49:
 
| "true"
 
| "true"
 
|}
 
|}
 
  
 
== Returned Parameters ==
 
== Returned Parameters ==
Line 77: 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
Line 92: Line 93:
 
</source>
 
</source>
  
[[Category:Development]]
+
= See Also =
 +
 
 +
* [[OpenSim Archives|How to use OpenSimulator Archives (OAR)]]
 +
* [[OAR Format 0.1]]
 +
* [[OAR Format 0.2]]
 +
 
 +
 
 +
[[Category:RemoteAdmin]]
 +
[[Category:RemoteAdmin Commands]]

Latest revision as of 15:27, 24 October 2015

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


Contents

[edit] 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,...


[edit] Parameters

[edit] Required Parameters

These parameters are required

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


[edit] 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"

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

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


[edit] Error messages

No error messages


[edit] Notes

[edit] Example

[edit] 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);
?>

[edit] See Also

Personal tools
General
About This Wiki