class FleetApp::Server

Defined in:

fleet_app/backup.cr
fleet_app/backup_and_restore.cr
fleet_app/brooce_command/create.cr
fleet_app/create.cr
fleet_app/delete.cr
fleet_app/get_game_id.cr
fleet_app/install_oxide.cr
fleet_app/load_world.cr
fleet_app/restart.cr
fleet_app/start.cr
fleet_app/stop.cr
fleet_app/update.cr
fleet_app/update_config.cr
fleet_app/wipe_world.cr

Class Method Summary

Class Method Detail

def self.backup(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", backup_date : String = "", server_type : String = "", world_id : String = "", backup_id : String = "", server_name : String = "") #

Backs up the loaded world of the specified game.

The server will need to be stopped, the target world will be backed up, then the server will be restarted.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.backup_and_restore(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", loaded_world_name : String = "", loaded_backup_date : String = "", server_type : String = "", loaded_world_id : String = "", loaded_backup_id : String = "", restoration_url : String = "", restoration_world_name : String = "", restoration_backup_date : String = "", restoration_world_id : String = "", server_name : String = "") #

Back up the loaded world of the specified game then restore and load the selected world.

The server will need to be stopped, the current world will be backed up, the target world will be restored, then the server will be restarted.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.backup_and_restore_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", loaded_world_name : String = "", loaded_backup_date : String = "", server_type : String = "", loaded_world_id : String = "", loaded_backup_id : String = "", restoration_url : String = "", restoration_world_name : String = "", restoration_backup_date : String = "", restoration_world_id : String = "", server_name : String = "") #

[View source]
def self.backup_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", backup_date : String = "", server_type : String = "", world_id : String = "", backup_id : String = "", server_name : String = "") #

[View source]
def self.create(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", server_type : String = "") #

Creates a server for a game.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.create_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", server_type : String = "") #

[View source]
def self.delete(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Deletes a server for a game.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.delete_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.get_game_id(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production") #

Used to get the game_id for Core Keeper servers

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. Only accepts FleetApp::Game::CORE_KEEPER.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.install_oxide(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Installs Oxide on a rust server.

This is different from creating a game server. Starting a game server assumes that the server has already been created, and is starting from a stopped state.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.install_oxide_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.load_world(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", server_type : String = "", world_id : String = "") #

Loads a world of the specified game.

This is called when loading a different world for the server. The server will need to be stopped, the target world will be reassigned, then the server will be restarted.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.load_world_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", server_type : String = "", world_id : String = "") #

[View source]
def self.restart(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Restarts a server for a game.

This is different from creating a game server. Starting a game server assumes that the server has already been created, and is starting from a stopped state.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.restart_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.start(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Starts a server for a game.

This is different from creating a game server. Starting a game server assumes that the server has already been created, and is starting from a stopped state.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.start_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.stop(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Stops a game server.

Stopping a game server assumes that the server is currently running.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.stop_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.update(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "") #

Updates a server for a game.

This is different from creating a game server. Starting a game server assumes that the server has already been created, and is starting from a stopped state.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.update_config(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", server_type : String = "") #

Updates a specified game's configuration.

This is called when updating a server configuration file which is different for each game. The server will need to be stopped before any configuration files are edited, then the server will be restarted.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.update_config_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "", server_type : String = "") #

[View source]
def self.update_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "") #

[View source]
def self.wipe_world(host : String, game_name : String, server_id : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "") #

Wipes a Project Zomboid server's world.

This is different from creating a game server. Starting a game server assumes that the server has already been created, and is starting from a stopped state.

Use host to specify the queue name in brooce to send to. For example, use 2013191.xyz if the command should be executed on tms1. If you don't know which queue to send to, the SRE lead should be able to advise you based on how they configured brooce.

Use game_name to specify the game you are sending a brooce command for. See: FleetApp::Game for possible values.

Use server_id to specify the internal Hostari id. Can be a subscription_id from GamesSite, or a server_id from VSH.

body is an optional, JSON-formatted string that is sent as the request body which defaults to an empty string. This is used to override the default command in fleet app. For example, you can send this: {command: "echo 'foobar'"}.to_json

environment is an optional string that specifies which fleet app to send the request to.


[View source]
def self.wipe_world_with_auth(host : String, game_name : String, server_id : String, basic_auth : String, body : String = "", environment : String = "production", username : String = "", world_name : String = "") #

[View source]