RemoteAdmin:admin acl remove
From OpenSimulator
(Difference between revisions)
m (→Required Parameters: Replace region_uuid by region_id) |
|||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 19: | Line 19: | ||
|- | |- | ||
| ''region_name'' | | ''region_name'' | ||
| − | | Region name to add user, optionaly use | + | | Region name to add user, optionaly use region_id |
| | | | ||
|- | |- | ||
| ''users'' | | ''users'' | ||
| list of users names to be removed | | list of users names to be removed | ||
| − | | eg. " | + | | eg. "John Doe" |
|} | |} | ||
| − | |||
=== Optional Parameters === | === Optional Parameters === | ||
| Line 37: | Line 36: | ||
! Values | ! Values | ||
|- | |- | ||
| − | | '' | + | | ''region_id'' |
| region uuid | | region uuid | ||
| | | | ||
|} | |} | ||
| − | |||
== Returned Parameters == | == Returned Parameters == | ||
| Line 71: | Line 69: | ||
== 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 86: | Line 86: | ||
</source> | </source> | ||
| − | [[RemoteAdmin]] | + | |
| − | [[ | + | |
| + | [[Category:RemoteAdmin]] | ||
| + | [[Category:RemoteAdmin Commands]] | ||
Latest revision as of 16:40, 26 October 2021
admin_acl_remove remotely allows to remove a list of users from the access control list
Contents |
[edit] Enabling admin_acl_remove
If not all functions are enabled, use admin_acl_remove to enable the function in the [RemoteAdmin] section
enabled_methods = admin_acl_remove,...
[edit] Parameters
[edit] Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_name | Region name to add user, optionaly use region_id | |
| users | list of users names to be removed | eg. "John Doe" |
[edit] Optional Parameters
These parameters are optional and do not need to be set
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid |
[edit] Returned Parameters
[edit] Returned Parameters
These parameters are returned by Remote Admin
| parameter | Description | Values |
|---|---|---|
| success | true when successfull | true, false |
| removed | number count of removed users |
[edit] Error messages
[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_acl_remove (multiple parameters) $parameters = array('region_name' => 'My Plaza', 'users' => 'John Doe'); $myRemoteAdmin->SendCommand('admin_acl_remove', $parameters); ?>
