Server Management – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Changed adminPassword to passwordAdmin)
m (Fix permissions)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}
{{Feature|informative|See also: [[Arma Reforger:Server Hosting|Server Hosting]].}}
{{Feature|informative|See also: {{Link|Arma Reforger:Server Hosting|Server Hosting}}.}}




Line 6: Line 6:


An in-game server administrator can be:
An in-game server administrator can be:
* ''the player hosting the server''
* the player hosting the server (PC only)
* a logged-in admin, using {{hl|[[#login]] [[Arma Reforger:Server Hosting#passwordAdmin|passwordAdmin]]}}
* a logged-in admin, using {{hl|[[#login]] [[Arma Reforger:Server Config#passwordAdmin|passwordAdmin]]}}
* ''a voted-in admin through the {{hl|#vote admin}} command''
* a voted-in admin


{{Feature|important|As of {{armaR}} 0.9.'''7''' the {{hl|#vote}} command is not implemented, leaving only the {{Link|#login|logged-in admin}} option for now.}}


== Permissions ==


== Permissions ==
<div style="display: flex; flex-wrap: wrap; align-items: flex-start; justify-content: space-around">


{| class="wikitable sortable align-left-col-1" style="text-align: center"
{| class="wikitable sortable align-center valign-middle align-left-col-1"
|- class="align-center"
|+ Standard
! rowspan="2" | Right
|- class="align-center valign-middle"
! colspan="3" | Roles
! rowspan="2" style="text-align: center; min-width: 8em" | Right
! colspan="3" | Player Role
! colspan="2" | RCON Permission
|- class="align-center"
|- class="align-center"
! Logged Admin
! Logged Admin
<!-- ! Voted Admin -->
! Voted Admin
! Player
! Player
! RCON Admin
! RCON Monitor
|-
|-
| {{hl|#login}}
| {{hl|#login}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
<!-- | {{Icon|unchecked}} -->
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#logout}}
| {{hl|#logout}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#roles}}
| {{hl|#roles}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#restart}}
| {{hl|#restart}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|unchecked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#shutdown}}
| {{hl|#shutdown}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|unchecked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#kick}}
| {{hl|#kick}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#ban}}
| {{hl|#ban}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
| {{Icon|unchecked}}
| {{hl|#unban}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#bans}}
| {{hl|#id}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
|-
|-
| {{hl|#id}}
| {{hl|#players}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|checked}}
| {{Icon|checked}}
|}
{| class="wikitable sortable align-center valign-middle align-left-col-1"
|+ Custom
|- class="align-center valign-middle"
! rowspan="2" style="text-align: center; min-width: 8em" | Right
! colspan="3" | Player Role
! colspan="2" | RCON Permission
|- class="align-center"
! Logged Admin
! Voted Admin
! Player
! RCON Admin
! RCON Monitor
|-
|-
| {{hl|#players}}
| {{GVI|armaR|1.2.1|size= 0.75}} {{hl|@logout}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|checked}}
<!-- | {{Icon|checked}} -->
| {{Icon|checked}}
| {{Icon|checked}}
|}
|}
</div>




Line 86: Line 121:


Login as server administrator with the password set in server config's field {{hl|[[Arma Reforger:Server Hosting#passwordAdmin|passwordAdmin]]}}.
Login as server administrator with the password set in server config's field {{hl|[[Arma Reforger:Server Hosting#passwordAdmin|passwordAdmin]]}}.
{{Feature|informative|Admins (in server config) or Owner (in {{hl|ownerToken.bin}}) can use the command without password.}}
; Syntax
#login
#login <password>
; Example
; Example
#login
  #login myServersPassword
  #login myServersPassword


Line 129: Line 171:


Kick (eject) the player out of the server through their playerId (obtained by {{Link|#players}}). Said player can still rejoin the server.
Kick (eject) the player out of the server through their playerId (obtained by {{Link|#players}}). Said player can still rejoin the server.
; Syntax
#kick <playerId>
; Example
; Example
  #kick 123456789
  #kick 123456789
Line 134: Line 179:
=== ban ===
=== ban ===


This command prefixes ban-related commands: "create", "remove", "list"
Ban (eject and banish forever or for a certain duration in seconds) the player out of the server through their playerId (obtained by {{Link|#players}}). Said player cannot rejoin until ban expiration.
Ban (eject and banish forever or for a certain duration in seconds) the player out of the server through their playerId (obtained by {{Link|#players}}). Said player cannot rejoin until ban expiration.
{{Feature|important|This command can only be executed on a dedicated server.}}
==== create ====
Create a ban entry for the player related to the provided id.
; Syntax
#ban create <playerId or identityId or {{GVI|armaR|1.2.0|size= 0.75}} playerName> <durationInSeconds> <reason (optional)>
if using {{hl|playerId}}, the player must actually be connected to the server; use {{hl|identityId}} otherwise.
; Example
; Example
Ban for an hour
Ban for an hour
  #ban 123456789 3600
  #ban create 123456789 3600
Ban forever
Ban forever
  #ban 123456789 -1
  #ban create 123456789 0
{{Feature|informative|Bans are not persistent between server executions - a restart resets the ban list.}}
Ban with a reason
#ban create 123456789 86400 teamkilling
 
==== remove ====
Remove a ban entry linked to the provided identity, allowing the player to rejoin.


=== unban ===
; Syntax
#ban remove <identityId>


Unban (cancel the ban) the player, allowing them to rejoin.
; Example
; Example
  #unban 123456789
  #ban remove 123456789
 
==== list ====
List current bans in a format {{hl|BanID ; Player UID ; Duration}}.
{{Feature|important|
* If the ''page'' parameter is not provided then the first page is shown.
* RCON can show 25 bans per page while game only 10.
}}


=== bans ===
; Syntax
#ban list <page (optional)>


List bans in a format {{hl|BanID ; Player UID ; Duration}}
; Example
; Example
  #bans
  #ban list
#ban list 2


=== id ===
=== id ===
Line 165: Line 232:
; Example
; Example
  #players
  #players
== Custom RCON Commands ==
{{Feature|informative|Custom RCON commands are {{Name|bi|short}}-specific and are not part of RCON standards. They start with {{hl|@}} to differenciate them from standard commands.}}
{{ArgTitle|3|logout|{{GVI|armaR|1.2.1}}}}
De-authenticate RCON client on server server side which immediately frees the connection for new RCON client.
If the RCON client is killed without issuing this command, it is de-authenticated automatically after 45s due to connection timeout.


{{GameCategory|armaR|Support}}
{{GameCategory|armaR|Support}}

Latest revision as of 14:43, 18 December 2024

ⓘ
See also: Server Hosting.


Administrator Roles

An in-game server administrator can be:

  • the player hosting the server (PC only)
  • a logged-in admin, using #login passwordAdmin
  • a voted-in admin


Permissions

Standard
Right Player Role RCON Permission
Logged Admin Voted Admin Player RCON Admin RCON Monitor
#login Unchecked Unchecked Checked Unchecked Unchecked
#logout Checked Checked Unchecked Unchecked Unchecked
#roles Checked Checked Checked Unchecked Unchecked
#restart Checked Unchecked Unchecked Checked Unchecked
#shutdown Checked Unchecked Unchecked Checked Unchecked
#kick Checked Unchecked Unchecked Checked Unchecked
#ban Checked Unchecked Unchecked Checked Unchecked
#id Checked Checked Checked Unchecked Unchecked
#players Checked Checked Checked Checked Checked
Custom
Right Player Role RCON Permission
Logged Admin Voted Admin Player RCON Admin RCON Monitor
armareforger-symbol black.png1.2.1 @logout Unchecked Unchecked Unchecked Checked Checked


Commands

login

Login as server administrator with the password set in server config's field passwordAdmin.

ⓘ
Admins (in server config) or Owner (in ownerToken.bin) can use the command without password.
Syntax
#login
#login <password>
Example
#login
#login myServersPassword

logout

Example
#logout

roles

Print the list of server roles the player possesses.

Example
#roles

restart

Restart the actually running scenario. The server keeps the clients connected.

Example
#restart

shutdown

Shut down the server, disconnecting all the clients.

Example
#shutdown

kick

Kick (eject) the player out of the server through their playerId (obtained by players). Said player can still rejoin the server.

Syntax
#kick <playerId>
Example
#kick 123456789

ban

This command prefixes ban-related commands: "create", "remove", "list" Ban (eject and banish forever or for a certain duration in seconds) the player out of the server through their playerId (obtained by players). Said player cannot rejoin until ban expiration.

⚠
This command can only be executed on a dedicated server.

create

Create a ban entry for the player related to the provided id.

Syntax
#ban create <playerId or identityId or armareforger-symbol black.png1.2.0 playerName> <durationInSeconds> <reason (optional)>

if using playerId, the player must actually be connected to the server; use identityId otherwise.

Example

Ban for an hour 

#ban create 123456789 3600

Ban forever 

#ban create 123456789 0

Ban with a reason 

#ban create 123456789 86400 teamkilling

remove

Remove a ban entry linked to the provided identity, allowing the player to rejoin.

Syntax
#ban remove <identityId>
Example
#ban remove 123456789

list

List current bans in a format BanID ; Player UID ; Duration.

⚠
  • If the page parameter is not provided then the first page is shown.
  • RCON can show 25 bans per page while game only 10.
Syntax
#ban list <page (optional)>
Example
#ban list
#ban list 2

id

Gives the local player's id.

Example
#id

players

Lists session's players and their playerId.

Example
#players


Custom RCON Commands

ⓘ
Custom RCON commands are BI-specific and are not part of RCON standards. They start with @ to differenciate them from standard commands.

logout

De-authenticate RCON client on server server side which immediately frees the connection for new RCON client. If the RCON client is killed without issuing this command, it is de-authenticated automatically after 45s due to connection timeout.

Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Server_Management&oldid=370483"