RemoteAdmin:admin save xml
From OpenSimulator
(Difference between revisions)
(Created page with "'''admin_save_xml''' remotely allows to save a xml region backup === Enabling admin_save_xml === If not all functions are enabled, use admin_create_region to enable the functio...") |
JeffKelley (Talk | contribs) m (→PHP: Fixed broken Google Code link, replacing with internal page) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''admin_save_xml''' remotely allows to | + | '''admin_save_xml''' remotely allows to execute the Save XML command |
| Line 37: | Line 37: | ||
! Values | ! Values | ||
|- | |- | ||
| − | | '' | + | | ''region_id'' |
| region uuid, optional region_name | | region uuid, optional region_name | ||
| | | | ||
| Line 45: | Line 45: | ||
| 1, 2 | | 1, 2 | ||
|} | |} | ||
| − | |||
== Returned Parameters == | == Returned Parameters == | ||
| Line 76: | Line 75: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
| Line 91: | Line 92: | ||
</source> | </source> | ||
| − | [[Category: | + | |
| + | [[Category:RemoteAdmin]] | ||
| + | [[Category:RemoteAdmin Commands]] | ||
Latest revision as of 11:36, 16 March 2021
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); ?>
