RemoteAdmin:admin shutdown

From OpenSimulator

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

Latest revision as of 16:29, 24 October 2015

admin_shutdown remotely allows to shutdown the simulator. Agents in the Region recieve a warning. All regions in the instance will be shut down. When using the optional shutdown and milliseconds parameter the shut down is delayed by the specified miliseconds.

Contents

[edit] Enabling admin_shutdown

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

enabled_methods = admin_shutdown,...

[edit] Parameters

[edit] Required Parameters

No parameters are required


[edit] Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
shutdown use shutdown together with milliseconds to trigger a delayed shutdown. "delayed"
milliseconds miliseconds till region shuts down. "delayed"


[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true
accepted true when successfull true, false
error error message when not successfull


[edit] Error messages

[edit] Notes

  • Returned Parameter success only implemeted for true, patch in work by Michelle Argus to implement success fully


[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_create_user (multiple parameters)
$parameters = array('region_id'=> $region_id, 'shutdown' => 'delayed', 'milliseconds' => 60000);
$myRemoteAdmin->SendCommand('admin_close_region', $parameters);
?>
Personal tools
General
About This Wiki