RemoteAdmin:admin region query

admin_region_query remotely allows to query the "health" of a region.

Enabling admin_region_query

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

enabled_methods = admin_region_query,...

Parameters

Required Parameters

These parameters are required

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

Optional Parameters

These parameters are optional and do not need to be set

parameter	Description	Values
region_id	region uuid of the region.

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
health	health data of the region	integer value

Error messages

When an error occures the following error value are returned

• failed to switch to region {REGION NAME}
• failed to switch to region {REGION UUID}
• neither region_name nor region_uuid given

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_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_region_query', $parameters);
?>