RemoteAdmin:admin restart
From OpenSimulator
(Difference between revisions)
(Created page with "'''admin_restart''' remotely allows to triggers a region to restart. === Enabling admin_restart === If not all functions are enabled, use admin_restart to enable the function ...") |
(→PHP) |
||
| Line 73: | Line 73: | ||
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); | $myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); | ||
| − | // Invoke | + | // Invoke admin_restart (multiple parameters) |
$parameters = array('regionID' => '000000-0000-0000-0000-00000000'); | $parameters = array('regionID' => '000000-0000-0000-0000-00000000'); | ||
$myRemoteAdmin->SendCommand('admin_restart', $parameters); | $myRemoteAdmin->SendCommand('admin_restart', $parameters); | ||
Revision as of 10:58, 9 December 2011
admin_restart remotely allows to triggers a region to restart.
Contents |
Enabling admin_restart
If not all functions are enabled, use admin_restart to enable the function in the [RemoteAdmin] section
enabled_methods = admin_restart,...
Parameters
Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| regionID | region uuid of the region |
Optional Parameters
No optional parameters
Returned Parameters
Returned Parameters
These parameters are returned by Remote Admin
| parameter | Description | Values |
|---|---|---|
| success | true when successfull | true, false |
| error | error message when not successfull | |
| rebooting | true when region is restarting | true, false |
Error messages
When an error occures the following error value are returned
- region not found
Notes
- accepted is an optional returned parameter, probably used prior to success
Example
PHP
<?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_restart (multiple parameters) $parameters = array('regionID' => '000000-0000-0000-0000-00000000'); $myRemoteAdmin->SendCommand('admin_restart', $parameters); ?>
