View source for 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
<source lang="csharp">
enabled_methods = admin_region_query,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! 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
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_id''
| region uuid of the region.
|
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! 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


== Notes ==



== Example ==
=== PHP ===
This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].

<source lang="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_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_region_query', $parameters);
?>
</source>



[[Category:RemoteAdmin]]
[[Category:RemoteAdmin Commands]]