RemoteAdmin:admin close region

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 95: Line 95:
[[Category:RemoteAdmin Commands]]

Latest revision as of 16:18, 24 October 2015

admin_close_region remotely allows to close regions. No changes are done to the database. The region will be shutdown and removed from the map.


[edit] Enabling admin_close_region

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

enabled_methods = admin_close_region,...

[edit] Parameters

[edit] Required Parameters

These parameters are required

parameter Description Values
region_name Name of the region, optionaly use region_id

[edit] Optional Parameters

These parameters are optional and do not need to be set

parameter Description Values
region_id region uuid of the region.

[edit] Returned Parameters

[edit] Returned Parameters

These parameters are returned by Remote Admin

parameter Description Values
success true when successfull true, false
error error message when not successfull
region_name name of region when using region_name
region_id name uuid of region when using region_id

[edit] Error messages

When an error occures the following error value are returned

  • region \"{REGION NAME}\" does not exist
  • region \"{REGION UUID}\" does not exist

[edit] Notes

  • use admin_delete_region if you also want to remove the region from the database

[edit] Example

[edit] PHP

This example needs the RemoteAdmin PHP Class file available here.

// Including the RemoteAdmin PHP class.
// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('', 9000, 'secret');
// Invoke admin_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_close_region', $parameters);
Personal tools
About This Wiki