RemoteAdmin

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(RemoteAdmin Commands)
 
(20 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__ {{Quicklinks}} <br>
+
{{Quicklinks}}
 +
 
 +
== Introduction ==
 +
 
 +
RemoteAdmin is an interface for simulators that allows various operations to be executed from outside the simulator.  '''Operations that relate to the simulator itself (e.g teleport user) are always available.  Those that relate to grid services (user creation and updating) are only available in standalone mode.  In grid mode, one has to use ROBUST level [[UserManipulation]] capabilities instead.'''
  
 
== How to Setup the Remote Admin interface ==
 
== How to Setup the Remote Admin interface ==
Line 12: Line 16:
 
  enabled_methods = all
 
  enabled_methods = all
  
See OpenSim.ini.example in the OpenSim distribution for more details.
+
See OpenSim.ini.example in the OpenSimulator distribution for more details.
  
 
=== Further options ===
 
=== Further options ===
Line 21: Line 25:
 
  port = <port-number>
 
  port = <port-number>
  
== RemoteAdmin Commands ==
+
== RemoteAdmin Commands ==
 
+
<div style="background-color:#FFA0A0; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
 +
'''Caution ! All commands using parameters for the uuid of a region use "region_id" as parameter. All other parameters eg. region_uuid or regionID will be removed after June 2012'''
 +
</div>
  
 
=== Agent management ===
 
=== Agent management ===
*[[Remoteadmin:admin teleport agent|admin_teleport_agent]]  
+
*[[Remoteadmin:admin teleport agent|admin_teleport_agent]]
 +
*[[Remoteadmin:admin get agents|admin_get_agents]] (post OpenSimulator 0.7.5)
  
=== User management ===
+
=== User account management ===
 
*[[RemoteAdmin:admin create user|admin_create_user]]  
 
*[[RemoteAdmin:admin create user|admin_create_user]]  
 
*[[RemoteAdmin:admin create user email|admin_create_user_email]]  
 
*[[RemoteAdmin:admin create user email|admin_create_user_email]]  
 
*[[RemoteAdmin:admin exists user|admin_exists_user]]  
 
*[[RemoteAdmin:admin exists user|admin_exists_user]]  
 
*[[RemoteAdmin:admin update user|admin_update_user]]
 
*[[RemoteAdmin:admin update user|admin_update_user]]
 +
*[[RemoteAdmin:admin authenticate user|admin_authenticate_user]] (not in 0.7.6.1)
 +
 +
=== Object management ===
 +
 +
=== Parcel management ===
  
 
=== Region management ===
 
=== Region management ===
Line 44: Line 56:
  
 
=== Region file management ===
 
=== Region file management ===
{{multicol}}
+
* [[RemoteAdmin:admin load heightmap|admin_load_heightmap]]
*[[RemoteAdmin:admin load heightmap|admin_load_heightmap]]
+
* [[RemoteAdmin:admin load oar|admin_load_oar]]  
*[[RemoteAdmin:admin load oar|admin_load_oar]]  
+
* [[RemoteAdmin:admin load xml|admin_load_xml]]  
*[[RemoteAdmin:admin load xml|admin_load_xml]]  
+
* [[RemoteAdmin:admin save heightmap|admin_save_heightmap]]  
*[[RemoteAdmin:admin save heightmap|admin_save_heightmap]]  
+
* [[RemoteAdmin:admin save oar|admin_save_oar]]  
*[[RemoteAdmin:admin save oar|admin_save_oar]]  
+
* [[RemoteAdmin:admin save xml|admin_save_xml]]
*[[RemoteAdmin:admin save xml|admin_save_xml]]  
+
 
+
  
 
=== Region access management ===
 
=== Region access management ===
*[[RemoteAdmin:admin acl list|admin_acl_list]]  
+
* [[RemoteAdmin:admin acl list|admin_acl_list]]  
*[[RemoteAdmin:admin acl clear|admin_acl_clear]]  
+
* [[RemoteAdmin:admin acl clear|admin_acl_clear]]  
*[[RemoteAdmin:admin acl add|admin_acl_add]]  
+
* [[RemoteAdmin:admin acl add|admin_acl_add]]  
*[[RemoteAdmin:admin acl remove|admin_acl_remove]]
+
* [[RemoteAdmin:admin acl remove|admin_acl_remove]]
 +
 
 +
=== Estate management ===
 +
* [[RemoteAdmin:admin estate reload|admin_estate_reload]]
  
 
=== Administration ===
 
=== Administration ===
*[[RemoteAdmin:admin console command|admin_console_command]]
+
* [[RemoteAdmin:admin console command|admin_console_command]]
  
== Subcategories  ==
+
=== Misc (Undocumented) ===
 +
* [[RemoteAdmin:admin dialog|admin_dialog]]
 +
* [[RemoteAdmin:admin reset land|admin_reset_land]]
 +
* [[RemoteAdmin:admin refresh search|admin_refresh_search]]
 +
* [[RemoteAdmin:admin refresh map|admin_refresh_map]]
 +
* [[RemoteAdmin:admin get opensim version|admin_get_opensim_version]]
 +
* [[RemoteAdmin:admin get agent count|admin_get_agent_count]]
  
*[[RemoteAdmin:RemoteAdmin Examples|RemoteAdmin Examples]]
+
== Subcategories ==
*[[RemoteAdmin:RemoteAdmin Proposals|RemoteAdmin Proposals]]
+
*[[RemoteAdmin:RemoteAdmin Standards|RemoteAdmin Standards]]
+
*[[RemoteAdmin:RemoteAdmin Implement new command|RemoteAdmin How to implement new commands]]
+
  
 +
* [[RemoteAdmin:RemoteAdmin Examples|RemoteAdmin Examples]]
 +
* [[RemoteAdmin:RemoteAdmin Proposals|RemoteAdmin Proposals]]
 +
* [[RemoteAdmin:RemoteAdmin Standards|RemoteAdmin Standards]]
 +
* [[RemoteAdmin:RemoteAdmin Implement new command|RemoteAdmin How to implement new commands]]
 +
* [[RemoteAdmin:RemoteAdmin Class|RemoteAdmin Class]]
  
[[Category:Development]][[Category:RemoteAdmin]]
+
[[Category:Development]]
 +
[[Category:RemoteAdmin]]

Latest revision as of 12:24, 14 April 2017

Contents

[edit] Introduction

RemoteAdmin is an interface for simulators that allows various operations to be executed from outside the simulator. Operations that relate to the simulator itself (e.g teleport user) are always available. Those that relate to grid services (user creation and updating) are only available in standalone mode. In grid mode, one has to use ROBUST level UserManipulation capabilities instead.

[edit] How to Setup the Remote Admin interface

First you should enable the remote admin interface to do so just add the following lines to your OpenSim.ini file Port should be set to a nonzero value to have the remote admin on a different port

As of r/16843 you can limit access to remote admin to specific IP addresses by using the optional access_ip_addresses. You can list all IP's allowed to access remote admin by seperating each IP by a comma. If access_ip_addresses isn't set, then all IP addresses can access RemoteAdmin.

[RemoteAdmin]
enabled = true
access_password = secret
enabled_methods = all

See OpenSim.ini.example in the OpenSimulator distribution for more details.

[edit] Further options

You can also specify a different port for the XMLRPCAdmin command listener from the default simulator HTTP port

[RemoteAdmin]
port = <port-number>

[edit] RemoteAdmin Commands

Caution ! All commands using parameters for the uuid of a region use "region_id" as parameter. All other parameters eg. region_uuid or regionID will be removed after June 2012

[edit] Agent management

[edit] User account management

[edit] Object management

[edit] Parcel management

[edit] Region management

[edit] Region file management

[edit] Region access management

[edit] Estate management

[edit] Administration

[edit] Misc (Undocumented)

[edit] Subcategories

Personal tools
General
About This Wiki