RemoteAdmin:admin region query
From OpenSimulator
(Difference between revisions)
JeffKelley (Talk | contribs) m (→PHP: Fixed broken Google Code link, replacing with internal page) |
|||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 31: | Line 31: | ||
! Values | ! Values | ||
|- | |- | ||
| − | | '' | + | | ''region_id'' |
| region uuid of the region. | | region uuid of the region. | ||
| | | | ||
|} | |} | ||
| − | |||
== Returned Parameters == | == Returned Parameters == | ||
| Line 64: | Line 63: | ||
When an error occures the following error value are returned | When an error occures the following error value are returned | ||
| − | *failed to switch to region {REGION NAME} | + | * failed to switch to region {REGION NAME} |
| − | *failed to switch to region {REGION UUID} | + | * failed to switch to region {REGION UUID} |
| − | *neither region_name nor region_uuid given | + | * neither region_name nor region_uuid given |
| Line 75: | Line 74: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
| Line 90: | Line 91: | ||
</source> | </source> | ||
| − | [[Category: | + | |
| + | |||
| + | [[Category:RemoteAdmin]] | ||
| + | [[Category:RemoteAdmin Commands]] | ||
Latest revision as of 11:37, 16 March 2021
admin_region_query remotely allows to query the "health" of a region.
Contents |
[edit] 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,...
[edit] Parameters
[edit] Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_name | Name of the region, optionaly use region_uuid |
[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 | |
| health | health data of the region | integer value |
[edit] 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
[edit] Notes
[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_name' => 'My Plaza'); $myRemoteAdmin->SendCommand('admin_region_query', $parameters); ?>
