# erl_boot_server

###
Module

erl_boot_server

###
Module Summary

Boot server for other Erlang machines.

###
Description

This server is used to assist diskless Erlang nodes that fetch all Erlang code from another machine.

This server is used to fetch all code, including the start script, if an Erlang runtime system is started with command-line flag -loader inet. All hosts specified with command-line flag -hosts Host must have one instance of this server running.

This server can be started with the Kernel configuration parameter start_boot_server.

The erl_boot_server can read regular files and files in archives. See code(3) and erl_prim_loader(3) in ERTS.

Warning

The support for loading code from archive files is experimental. It is released before it is ready to obtain early feedback. The file format, semantics, interfaces, and so on, can be changed in a future release.

###
Exports

####
add_slave(Slave) -> ok | {error, Reason}

### Types

Slave = Host
Host = inet:ip_address() | inet:hostname()
Reason = {badarg, Slave}

Adds a Slave node to the list of allowed slave hosts.

####
delete_slave(Slave) -> ok | {error, Reason}

### Types

Slave = Host
Host = inet:ip_address() | inet:hostname()
Reason = {badarg, Slave}

Deletes a Slave node from the list of allowed slave hosts.

####
start(Slaves) -> {ok, Pid} | {error, Reason}

### Types

Slaves = [Host]
Host = inet:ip_address() | inet:hostname()
Pid = pid()
Reason = {badarg, Slaves}

Starts the boot server. Slaves is a list of IP addresses for hosts, which are allowed to use this server as a boot server.

####
start_link(Slaves) -> {ok, Pid} | {error, Reason}

### Types

Slaves = [Host]
Host = inet:ip_address() | inet:hostname()
Pid = pid()
Reason = {badarg, Slaves}

Starts the boot server and links to the caller. This function is used to start the server if it is included in a supervision tree.

####
which_slaves() -> Slaves

### Types

Slaves = [Slave]
Slave =
{Netmask :: inet:ip_address(), Address :: inet:ip_address()}

Returns the current list of allowed slave hosts.

###
SEE ALSO

erts:init(3), erts:erl_prim_loader(3)