RemoteAdmin:admin save xml

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(PHP)
m
 
Line 92: Line 92:
 
</source>
 
</source>
  
[[RemoteAdmin]]
+
 
[[RemoteAdmin:Commands]]
+
[[Category:RemoteAdmin]]
 +
[[Category:RemoteAdmin Commands]]

Latest revision as of 16:29, 24 October 2015

admin_save_xml remotely allows to execute the Save XML command


Contents

[edit] Enabling admin_save_xml

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

enabled_methods = admin_save_xml,...


[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
xml_version xml_version, default 1 1, 2

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
switched true when region was found true, false
saved true when successfully saved xml


[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_save_xml (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'filename' => 'my_backup.xml');
$myRemoteAdmin->SendCommand('admin_save_xml', $parameters);
?>
Personal tools
General
About This Wiki