RemoteAdmin:admin load xml
From OpenSimulator
(Difference between revisions)
m (moved Remoteadmin:admin load xml to RemoteAdmin:admin load xml: spelling) |
m |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 37: | Line 37: | ||
! Values | ! Values | ||
|- | |- | ||
− | | '' | + | | ''region_id'' |
| region uuid | | region uuid | ||
| | | | ||
Line 45: | Line 45: | ||
| 1, 2 | | 1, 2 | ||
|} | |} | ||
− | |||
== 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: | + | |
+ | [[Category:RemoteAdmin]] | ||
+ | [[Category:RemoteAdmin Commands]] |
Revision as of 16:28, 24 October 2015
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); ?>