RemoteAdmin:admin shutdown

From OpenSimulator

(Redirected from Remoteadmin:admin shutdown)
Jump to: navigation, search

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

Enabling admin_shutdown

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

enabled_methods = admin_shutdown,...

Parameters

Required Parameters

No parameters are required


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"


Returned Parameters

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


Error messages

Notes

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


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_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