RemoteAdmin:admin load xml

From OpenSimulator

Revision as of 12:37, 16 March 2021 by JeffKelley (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

admin_load_xml remotely allows to execute the Load XML command.


Contents

Enabling admin_load_xml

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

enabled_methods = admin_load_xml,...


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

Returned Parameters

Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
loaded true when successfully loaded file true, false
switched true when region was found 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_xml (multiple parameters)
$parameters = array('region_name' => 'My Plaza', 'filename' => 'my_xml_backup.xml');
$myRemoteAdmin->SendCommand('admin_load_xml', $parameters);
?>
Personal tools
General
About This Wiki