Table of Contents
Webmin is a centralized administration tool, thanks to a classic web browser. Webmin's goal is the remote administration of a UNIX machine, via any machine with any web browser featuring tables and HTML forms. More information at the Webmin official website: http://www.webmin.com .
A Webmin module has been developed to ease access to configuration files. The Webmin module generates the configuration files and handles disk stored images (move local images to base/shared images, delete, etc).
With a web browser, connect to the LRS server IP address on port 10000. Example: https://my.server.com:10000 Please note that in function of your Webmin configuration, you may need to use an unencrypted HTTP connection. In that case, you will have to replace https by http .
After a successful log in, you should see this page:
The LRS module is located in the Others Webmin category :
The LRS module's index page contains a list of all host names currently registered (e.g. declared) on the LRS server.
When using the module for the first time, it is possible that no host has been registered on the LRS. In that case, the module will display the message: No registered hosts on the index page. Below is an example:
There are two alternatives to register (e.g. declare) a new host:
Use Automatic Recording. This is the recommended way to declare a new client computer on the LRS server. This recording is performed by the server at client boot time.
Recording Using the DHCP Form. To use the DHCP form, you must know the MAC address that belong to the client's network card, and the IP addressing scheme of the local network. For more information, see Section 3.5, “The DHCP Form”.
As you can see on the above screenshot, the page which shows LRS essential functions, is divided in three parts.
On each page, you will find the following links on the top right part of the page:
Webmin index: To return to the Webmin index page.
Help: contextual help.
Module config: To change the configuration parameters which are specific to the LRS module.
Exit: To log out or switch to another user.
You can also use the navigation bar to move between the different sections of Webmin.
Webmin will navigate you to a location where you will be able to set up the LRS web interface.
System will navigate you to a location where you will be able to modify a certain amount of parameters, such as users, scheduler or services.
Servers will navigate you to a location where you will be able to set up the different services running on the LRS.
Network will navigate you to a location where you will be able to set up the LRS network interfaces.
Hardware will navigate you to a location where you will be able to set up the LRS storage units.
Others concentrates the LRS main functions and a few useful tools.
The topmost left part of the interface always shows the actual location inside the interface and the version number of the current module.
The navigation tabs enable you to quickly switch between the different modules of the LRS. Depending on the context, some will not be activated.
The first tabs level can be used to switch from one LRS module to another.
The second level is used to switch between functions inside the top level module.
A third level may sometimes appear to give access to sub functions.
The selected tabs have a white background and are written in bold black letters, the non-selected tabs are written in black, the tabs which can't be selected are written in gray.
The list on the bottom part of the interface is a multi-dimensional array organized in tabs, lines and columns:
The first dimension ("functional") is represented by tabs, each tabs showing clients belonging to the profile of the same name (for example here, the "All" profile is selected). Two tabs will always be shown:
The "all" tab (on the left) which displays all registered clients, with or without a profile.
The "no profile" tab, on the right, which displays clients without profile.
The other tabs will appear only if clients belonging to those profiles are available (see Chapter 10, Client Naming Convention for more information about the computers organization method).
The second dimension ("geographical") is represented by the table's rows, each row containing either a client () or a group of clients (). The clients are tree-organized (see Chapter 10, Client Naming Convention for more information about the computers organization method).
The third dimension is consists of the columns of the table, each column proposing:
Access points towards the functions of the LRS, generally represented by icons; and
Information concerning the group and/or corresponding client.
The displayed columns depend on the modules installed on the LRS. The screen capture above represents a typical display on a LRS equipped system with the basic modules (System, Files, Inventory, Control, Wake on LAN):
Name columns contains the
Computer name for a client.
Group name for a group (in this case, clicking on its name will deploy its tree structure).
MAC Address columns, only if the LRS : System module is installed, contains:
The physical address (MAC) of a computer's network interface.
"N/A" for a group.
Images column, only if the LRS : System module is installed, contains:
The number of local images of this client.
Or the number of clients contained in the group.
Size column, only if the LRS : System module is installed, contains:
The total size in MB of the client's local images.
Or the total size in MB of clients backups contained in the group.
System column, only if the LRS : System module is installed, includes a link to the main page of the System module for the client or group concerned. For more details, see Section 4.2, “The Boot Menu”.
Files column, only if the LRS : Files module is installed, includes a link to the main page of the Files module for the client concerned. See Chapter 6, BackupPC Module.
Inventory column, only if the LRS : Inventory module is installed, includes a link to the main page of the Inventory module for the client / group concerned. See Chapter 7, Hardware and Software Inventory Module.
Control column, only if the LRS : Remote Control module is installed, includes a link to the main page of the Remote Control module for the client concerned. See Chapter 9, Remote Control Module.
Wake on LAN column, only if the LRS : Inventory module is installed, includes a link to the main page of the Inventory module for the client / group concerned. See Section 4.9, “Wake On LAN”.
Logs are used to see important events related to the LRS clients. The 'logs' tab, on the main list, can be used to get a summary of the clients' state:
On the summary page, the last 3 events are shown as well as the last restored image. On a single page, you can verify the restoration a clients group.
For more details, you can click on the magnifying glass in the right column.
Each event is associated to a colored icon. The coloing scheme
is:
Gray, for neutral events (client's boot, entry chosen, default entry changed),
Green, for completed event (completed backup, restoration or post-installation),
Orange, for actions in progress (started backup, restoration or post-installation),
Red, for critical errors (read/write error on the client's HD).
Usually, an orange blinking LED should always be followed by a green LED. A critical error (red), requires a manual intervention on the client to resolve the error.
Under the 'Configuration' tab, you can get access to all configuration tabs:
The 'system backup' tab, allows you to set restoration options (see below), change the default boot logo (14 colors 640x480 XPM file needed), customize a message displayed during backup and restoration, and change the password needed to add a client.
The 'licenses' tab allows you to view and modify your license key.
The 'post-installation' tab allows you to edit post-installation scripts (see the post-installation chapter).
The 'band-width' tab allows you to set traffic shaping limits (see below).
The 'files backup' tab allows you to view the status of the files backup module.
The 'emails' tab allows you to change the email addresses of the administrators responsible for each module.
And the 'configuration backup' tab to save or reload the current LRS configuration (details in Section 13.1, “LRS Configuration Back Up”)
An image restoration can be done in three different ways: TFTP at boot, NFS, or multicast TFTP. The restoration type can be chosen on the 'Home -> Configuration -> System backup module -> restoration type' page.
Each restoration type has its advantages:
tftp at boot: Maximum compatibility. The BIOS is used to drive the HD, so all SCSI/IDE/SATA controllers are theoretically supported.
nfs: Maximum speed (in unicast). Lower compatibility because a Linux kernel is launched for restoration.
mtftp: Multicast restoration. You have the guarantee that a mass restoration, will be fast and will not load your network.
For the mtftp restoration, you can tune the delay before downloading each data block (a data block can be to up to 40MB). This delay is used to synchronize the data multicasting to the clients. If some clients are too slow to follow the faster clients, and if this delay is not sufficient to allow the slower clients to catch up with the faster ones, then, another multicast stream is created for them. This approach guarantees that one client which has hardware problems, cannot jeopardize the restoration of other clients.
Below you will find the time for restoring a 2 GB image (630 M compressed), using different restoration types:
Table 3.1. Restoration Time
| Restoration type | PIII 500 Mhz client | P4 2.4Ghz client |
| tftp at boot | 8 min 30 sec | 6 min 20 sec |
| nfs | 6 min 40 sec | 3 min 5 sec |
| mtftp | 10 min 10 sec | 7 min |
Traffic shaping controls the maximum network throughput that will be used by the clients during a restoration. It is particularly useful to make sure that your network will not be saturated during a mass OS deployment.
Just specify the name of the related network interface, usually eth0, its theoretical throughput, and the allowed throughput for each of the LRSfunction:
TFTP or multicast TFTP restoration,
NFS restoration,
Files deployment using the LSC,
HTTP download on the server.
Units such as 'mbit', 'kbit' (kilo/mega bits per second) or 'kbps', 'mbps' (kilo/mega bytes per second) should be specified.
![]() | |
Warning, if you see an error messages in this table, it is because your kernel does not support HTB traffic shaping (QoS). Check that the following kernel options are set: CONFIG_NET_SCHED, CONFIG_NET_SCH_HTB, CONFIG_NET_SCH_SFQ, CONFIG_NET_CLS, CONFIG_NET_CLS_U32. If not, recompile your kernel (only kernel versions 2.4.20 and above support HTB). You can also check that you have the 'tc' binary usually provided by the 'iproute' package. |
![]() | |
technically, the traffic-shapping (TC) is setup using the following parameters:
|
This form is a simple way to manually register new hosts entries in the DHCP configuration file and in the LRS server.
Most of the time, this operation is performed by the LRS and DHCP services. In tthose cases, the only task involved for the administrator is to choose a valid host name for the new computer. Nevertheless, according to the network's management policy, it is sometimes necessary to have a more accurate control over the computers recording scheme, and this form assists with that configuration.
The Name field: This is the computer name. The name should be composed of alphanumeric characters only (ranges [a-z], [A-Z] and '-').
The MAC address field: it must be filled with the physical address of the host's network card. The address should be a string made of 6 hexadecimal values, delimited with semicolons ':' . (Example: 01:aa:45:e4:05:26). This field is pre-filled with the last seen DHCP request's MAC address.
The IP address: Specify 'Dynamic' if IP addresses are dynamically assigned (e.g. if you have nostaticip=1 in /etc/lbs.conf). If you manually enter an IP address, you must provide a valid IP address. In that case, the local DHCP server configuration will be modified to set a static DHCP address.
The Password field: This is a required field. It must contain the password allowing the registration.
When you register a new host with this form, a new entry is created in the file dhcpd.conf. Then, this information is duplicated to the LRS server (see etc/ether) which will create the directory needed to store data and configuration specific files for this host.
In the control center, the last icon in the 'Admin' column, allows to manage the clients with functions like renaming or deleting a client, and to schedule a Wake-On-Lan.
For each client, the following functions are available :
Rename allows you to modify the 'LRS' name of a client, and to assign it to a group of clients.
Change MAC address allows you to update the client's MAC address when you change its network interface card. It is important to set the right MAC address for each PC. If there's a mismatch, you will see the wrong boot menu.
Delete, deletes all data associated with an host, including backups.
The « Wake on LAN » links allows you to remotely start a client or a group of clients.
After having choosen between, a single wake-up and a perdiodic wake-up, you should see a page similar to this one below:
On that page, modify the 'Run on date' and 'Run at time' fields to schedule the WOL.
In the end, hit the 'Create' button. When the client wakes up, it will execute the default LRS boot menu entry.
Notes: You can assign a client to a group with the [Rename] button found on the client's menu page, and then wake a group of clients.
If you need to broadcast the WOL packets on different subnets, you can specify the broadcast addresses in the system backup configuration tab, in the 'list of broadcast addresses for WOL packets' text entry box.
This user interface supports language setting. You can choose that by selecting the Webmin configuration category, located into the Webmin tab on the Webmin main page.
For now, supported languages are English and French .
Command Shell
This module allows to do remote execution of shell commands on the server, as if executing from the console. An often used command is the 'ps' command, which lists currently running processes on the system. The 'ps' command helps to quickly know if LRS required services are active. Please review the Running Processes module located into the System tab.
File manager
This module is a Java applet which, as its name describes, gives you access to the server's tree. So here you have the ability to remotely modify files, without having to handle the LRS server in place.
| WARNING: Some versions of this module do not handle symbolic links! As the LRS server makes heavy use of symbolic links, it is strongly discouraged to move or modify directories using the Webmin File Manager. Nevertheless you can use the Webmin File Manager to edit file contents. |
|---|















![[Warning]](/ucome.rvt/any/en/Produits/LRS/details/doc/img/warning.png)
![[Note]](/ucome.rvt/any/en/Produits/LRS/details/doc/img/note.png)





