---
canonical: "https://safekit.eviden.com/wp-content/uploads/downloads_safekit/version-82/safekituserguidehtml/documentation/safekituserguideen.htm"
---


Evidian SafeKit User's Guide 8.2


**SafeKit User's Guide**

High Availability Software for Critical Applications

  

**Overview**

|  |  |  |
| --- | --- | --- |
| **Subject** | This document covers all the phases of the SafeKit implementation: architecture, installation, tests, administration & troubleshooting, support, and command line interface. | |
| **Intended   Readers** | **Architectures** | [Technical overview](#Archi) |
| **Installation** | [Installation](#Install) |
| **Console** | [The SafeKit web console](#Webconsole)  [Securing the SafeKit web service](#Https) |
| **Advanced configuration** | [Cluster.xml for the SafeKit cluster configuration](#Cluster)  [Userconfig.xml for an application module configuration](#Userconfig)  [Scripts for an application module configuration](#Userscripts)  [Examples of application module configurations](#Examples) |
| **Administration** | [Mirror module administration](#Mirroradmin)  [Farm module administration](#Farmadmin)  [Command line interface](#Command)  [Advanced administration](#Advancedadmin) |
| **Support** | [Tests](#Tests)  [Troubleshooting](#Troubleshooting)  [SafeKit support](#Evidiansupport)  [Log Messages Index](#LogMessagesIndex) |
| **Other** | [Table of Contents](#TableOfContents)  [Third-Party Software](#_Use_SafeKit_in) |
| Release | SafeKit 8.2 | |
| **Supported OS** | Windows and Linux; for a detailed list of supported OS, see [here](https://customercare.evidian.com/space/PDA/1252786262/Software+Release+Bulletin+-+SafeKit+8.2) | |
| **Web Sites** | [Marketing site](https://safekit.evidian.com/)                [Support portal](https://customercare.evidian.com/) | |
| Ref | 39 A2 38MC 07 | |
|  | | |

Copyright © Eviden,
2026

The trademarks mentioned in this document are the propriety of their
respective owners.

No part of this
publication may be reproduced, stored in a retrieval system or transmitted in
any form or by any means, electronic, mechanical or otherwise without the prior
written permission of the publisher.

Eviden disclaims
the implied warranties of merchantability and fitness for a particular purpose
and makes no express warranties except as may be stated in its written
agreement with and for its customer. In no event is Eviden liable to anyone for
any indirect, special, or consequential damages.

The information and
specifications in this document are subject to change without notice. Consult
your Eviden Marketing Representative for product or service availability.

  
  

**Table of Contents**

[Overview.. 3](#_Toc231369896)

[Table of Contents. 5](#_Toc231369897)

[1.... Technical overview.. 17](#_Toc231369898)

[1.1..... Generalities, solutions, architectures 17](#_Toc231369899)

[1.1.1       Introduction to SafeKit 17](#_Toc231369900)

[1.1.2       SafeKit solutions. 17](#_Toc231369901)

[1.1.3       SafeKit architectures. 18](#_Toc231369902)

[1.1.4       SafeKit cluster definition. 18](#_Toc231369903)

[1.1.5       SafeKit application module definition. 19](#_Toc231369904)

[1.1.6       SafeKit limitations. 19](#_Toc231369905)

[1.2..... The SafeKit mirror cluster 20](#_Toc231369906)

[1.2.1       Real time file replication and application failover 20](#_Toc231369907)

[1.2.2       Step 1. Normal operation. 21](#_Toc231369908)

[1.2.3       Step 2. Failover 21](#_Toc231369909)

[1.2.4       Step 3. Failback and automatic resynchronization. 21](#_Toc231369910)

[1.2.5       Step 4. Return to normal operation. 22](#_Toc231369911)

[1.2.6       Synchronous replication versus asynchronous replication. 22](#_Toc231369912)

[1.2.7       Behavior in case of network isolation. 22](#_Toc231369913)

[1.2.8       3-node replication. 23](#_Toc231369914)

[1.2.9       SafeKit on a single node to protect against software failures 23](#_Toc231369915)

[1.3..... The SafeKit farm cluster 24](#_Toc231369916)

[1.3.1       Network load balancing and application failover 24](#_Toc231369917)

[1.3.2       Principle of a virtual IP address with network load balancing. 24](#_Toc231369918)

[1.3.3       Load balancing for stateful or stateless web services 24](#_Toc231369919)

[1.3.4       Chain high availability solution in a farm.. 25](#_Toc231369920)

[1.4..... Clusters running several modules 25](#_Toc231369921)

[1.4.1       The SafeKit farm+mirror cluster 25](#_Toc231369922)

[1.4.2       The SafeKit active/active cluster with replication. 25](#_Toc231369923)

[1.4.3       The SafeKit N-1 cluster 26](#_Toc231369924)

[1.5..... The SafeKit Hyper-V or KVM cluster 27](#_Toc231369925)

[1.5.1       Load balancing, replication, failover of entire virtual machines. 27](#_Toc231369926)

[1.6..... SafeKit clusters in the cloud. 27](#_Toc231369927)

[1.6.1       Mirror cluster in Azure, AWS and GCP. 27](#_Toc231369928)

[1.6.2       Farm cluster in Azure, AWS and GCP. 28](#_Toc231369929)

[2.... Installation. 31](#_Toc231369930)

[2.1..... SafeKit install 31](#_Toc231369931)

[2.1.1       Download the package. 31](#_Toc231369932)

[2.1.2       Installation directories and disk space provisioning. 32](#_Toc231369933)

[2.1.3       SafeKit install procedure. 32](#_Toc231369934)

[2.1.4       Use the SafeKit web console or command line interface. 35](#_Toc231369935)

[2.1.5       SafeKit license keys. 37](#_Toc231369936)

[2.1.6       System specific procedures and characteristics 37](#_Toc231369937)

[2.2..... Mirror installation recommendation. 38](#_Toc231369938)

[2.2.1       Hardware and system prerequisites 38](#_Toc231369939)

[2.2.2       Network prerequisites. 38](#_Toc231369940)

[2.2.3       Application prerequisites. 38](#_Toc231369941)

[2.2.4       File replication prerequisites. 38](#_Toc231369942)

[2.3..... Farm installation recommendation. 39](#_Toc231369943)

[2.3.1       Hardware and system prerequisites 39](#_Toc231369944)

[2.3.2       Network prerequisites. 39](#_Toc231369945)

[2.3.3       Application prerequisites. 39](#_Toc231369946)

[2.4..... SafeKit upgrade. 39](#_Toc231369947)

[2.4.1       Prepare the upgrade. 39](#_Toc231369948)

[2.4.2       Uninstall procedure. 40](#_Toc231369949)

[2.4.3       Reinstall and postinstall procedure. 40](#_Toc231369950)

[2.5..... SafeKit full uninstall 42](#_Toc231369951)

[2.5.1       Uninstall on Windows as administrator 42](#_Toc231369952)

[2.5.2       Uninstall on Linux as root 43](#_Toc231369953)

[2.6..... SafeKit documentation. 44](#_Toc231369954)

[3.... The SafeKit web console. 45](#_Toc231369955)

[3.1..... Start the web console. 45](#_Toc231369956)

[3.1.1       Start a web browser 45](#_Toc231369957)

[3.1.2       Connect to a SafeKit node. 45](#_Toc231369958)

[3.1.3       List of connection nodes 46](#_Toc231369959)

[3.1.4       Use the SafeKit web application. 47](#_Toc231369960)

[3.1.5       Update the web console. 49](#_Toc231369961)

[3.2..... Configure the cluster 49](#_Toc231369962)

[3.2.1       Cluster configuration wizard. 50](#_Toc231369963)

[3.2.2       Cluster configuration home page. 53](#_Toc231369964)

[3.3..... Configure an application module. 54](#_Toc231369965)

[3.3.1       Select the new module to configure. 55](#_Toc231369966)

[3.3.2       Module configuration wizard. 56](#_Toc231369967)

[3.3.3       Modules configuration home page. 61](#_Toc231369968)

[3.3.4       Edit the module configuration locally and then apply it 63](#_Toc231369969)

[3.4..... Monitor an application module. 64](#_Toc231369970)

[3.4.1       Monitoring home page. 64](#_Toc231369971)

[3.4.2       Module state. 65](#_Toc231369972)

[3.4.3       Module control menus 67](#_Toc231369973)

[3.4.4       Module details. 70](#_Toc231369974)

[3.4.5       Module states timeline. 75](#_Toc231369975)

[3.5..... Snapshots or logs of application module for debug and support 76](#_Toc231369976)

[3.6..... Secure access to the web console. 77](#_Toc231369977)

[4.... Tests. 79](#_Toc231369978)

[4.1..... Installation and tests after boot 79](#_Toc231369979)

[4.1.1       Test package installation. 79](#_Toc231369980)

[4.1.2       Test license and version. 80](#_Toc231369981)

[4.1.3       Test SafeKit services and modules after boot 80](#_Toc231369982)

[4.1.4       Test start of SafeKit web console. 82](#_Toc231369983)

[4.2..... Tests of a mirror module. 83](#_Toc231369984)

[4.2.1       Test first start of a mirror module on 2 servers ![](safekituserguideen_fichiers/image002.png)STOP (NotReady). 83](#_Toc231369985)

[4.2.2       Test start of a mirror module on 2 servers ![](safekituserguideen_fichiers/image002.png)STOP (NotReady). 83](#_Toc231369986)

[4.2.3       Test stop of a mirror module on the server ![](safekituserguideen_fichiers/image003.png)PRIM (Ready). 83](#_Toc231369987)

[4.2.4       Test start of a mirror module on the server ![](safekituserguideen_fichiers/image002.png)STOP (NotReady). 84](#_Toc231369988)

[4.2.5       Test restart of a mirror module on the server ![](safekituserguideen_fichiers/image004.png)PRIM (Ready). 84](#_Toc231369989)

[4.2.6       Test virtual IP address of a mirror module. 84](#_Toc231369990)

[4.2.7       Test file replication of a mirror module. 85](#_Toc231369991)

[4.2.8       Test shutdown of the server ![](safekituserguideen_fichiers/image003.png)PRIM (Ready). 86](#_Toc231369992)

[4.2.9       Test power-off of the server ![](safekituserguideen_fichiers/image004.png)PRIM (Ready). 87](#_Toc231369993)

[4.2.10      Test split-brain with a mirror module. 87](#_Toc231369994)

[4.2.11      Continue your mirror module tests with checkers 89](#_Toc231369995)

[4.3..... Tests of a farm module. 89](#_Toc231369996)

[4.3.1       Test start of a farm module on all servers ![](safekituserguideen_fichiers/image002.png)STOP (NotReady). 89](#_Toc231369997)

[4.3.2       Test stop of a farm module on one server ![](safekituserguideen_fichiers/image003.png)UP (Ready). 89](#_Toc231369998)

[4.3.3       Test restart of a farm module on one server ![](safekituserguideen_fichiers/image005.jpg)UP(Ready). 89](#_Toc231369999)

[4.3.4       Test virtual IP address of a farm module. 89](#_Toc231370000)

[4.3.5       Test TCP load balancing on a virtual IP address. 91](#_Toc231370001)

[4.3.6       Test split-brain with a farm module. 92](#_Toc231370002)

[4.3.7       Test compatibility of the network with invisible MAC address
(vmac\_invisible) 93](#_Toc231370003)

[4.3.8       Test shutdown of a server ![](safekituserguideen_fichiers/image005.jpg)UP (Ready). 94](#_Toc231370004)

[4.3.9       Test power-off of a server ![](safekituserguideen_fichiers/image005.jpg)UP (Ready). 95](#_Toc231370005)

[4.3.10      Continue your farm module tests with checkers. 95](#_Toc231370006)

[4.4..... Tests of checkers common to mirror and farm.. 95](#_Toc231370007)

[4.4.1       Test <errd> checker with action restart or stopstart 95](#_Toc231370008)

[4.4.2       Test <tcp> checker with action restart or stopstart 96](#_Toc231370009)

[4.4.3       Test <tcp> checker with action wait 97](#_Toc231370010)

[4.4.4       Test <interface check="on"> with action wait 98](#_Toc231370011)

[4.4.5       Test <ping> checker with action wait 99](#_Toc231370012)

[4.4.6       Test <module> checker with action wait 99](#_Toc231370013)

[4.4.7       Test <custom> checker with action wait 100](#_Toc231370014)

[4.4.8       Test <custom> checker with action restart or stopstart 101](#_Toc231370015)

[5.... Mirror module administration. 105](#_Toc231370016)

[5.1..... Operating mode of a mirror module. 105](#_Toc231370017)

[5.2..... State automaton of a mirror module (STOP, WAIT, ALONE, PRIM, SECOND
- NotReady, Transient, Ready) 107](#_Toc231370018)

[5.3..... First start-up of a mirror module (safekit prim command) 108](#_Toc231370019)

[5.4..... Different reintegration cases (use of bitmaps) 109](#_Toc231370020)

[5.5..... Start-up of a mirror module with the up-to-date data  ![](safekituserguideen_fichiers/image006.jpg)STOP (NotReady) - ![](safekituserguideen_fichiers/image007.png)WAIT (NotReady). 110](#_Toc231370021)

[5.6..... Degraded replication mode (![](safekituserguideen_fichiers/image003.png)ALONE (Ready) degraded) 111](#_Toc231370022)

[5.7..... Automatic or manual failover 112](#_Toc231370023)

[5.8..... Default primary server (automatic swap after reintegration) 114](#_Toc231370024)

[5.9..... Prim command fails: why? (safekit primforce command) 115](#_Toc231370025)

[6.... Farm module administration. 117](#_Toc231370026)

[6.1..... Operating mode of a farm module. 117](#_Toc231370027)

[6.2..... State automaton of a farm module (STOP, WAIT, UP - NotReady,
Transient, Ready) 118](#_Toc231370028)

[6.3..... Start-up of a farm module. 119](#_Toc231370029)

[7.... Troubleshooting. 121](#_Toc231370030)

[7.1..... Connection issues with the web console. 121](#_Toc231370031)

[7.1.1       Browser check. 122](#_Toc231370032)

[7.1.2       Browser state clear 122](#_Toc231370033)

[7.1.3       Server check. 122](#_Toc231370034)

[7.2..... Connection issues with the HTTPS web console. 123](#_Toc231370035)

[7.2.1       Check server certificates. 123](#_Toc231370036)

[7.2.2       Check certificates installed in SafeKit 124](#_Toc231370037)

[7.2.3       Revert to HTTP configuration. 125](#_Toc231370038)

[7.3..... Global environment checks (healthcheck script) 125](#_Toc231370039)

[7.4..... How to read logs and resources of the module? 125](#_Toc231370040)

[7.5..... How to read the commands log of the server? 126](#_Toc231370041)

[7.6..... Stable module  ![](safekituserguideen_fichiers/image003.png)(Ready) and ![](safekituserguideen_fichiers/image003.png)(Ready). 126](#_Toc231370042)

[7.7..... Degraded module ![](safekituserguideen_fichiers/image003.png)(Ready)and ![](safekituserguideen_fichiers/image008.png)/![](safekituserguideen_fichiers/image007.png)(NotReady). 126](#_Toc231370043)

[7.8..... Out of service module ![](safekituserguideen_fichiers/image008.png)/![](safekituserguideen_fichiers/image007.png)(NotReady) and ![](safekituserguideen_fichiers/image008.png)/![](safekituserguideen_fichiers/image007.png)(NotReady). 127](#_Toc231370044)

[7.9..... Module ![](safekituserguideen_fichiers/image008.png) STOP (NotReady):
start the module. 127](#_Toc231370045)

[7.10... Module ![](safekituserguideen_fichiers/image007.png)WAIT (NotReady): repair the
resource="down" 127](#_Toc231370046)

[7.11... Module oscillating from ![](safekituserguideen_fichiers/image003.png) (Ready) to
![](safekituserguideen_fichiers/image009.png) (Transient). 128](#_Toc231370047)

[7.12... Message on stop after maxloop. 129](#_Toc231370048)

[7.13... Module ![](safekituserguideen_fichiers/image003.png) (Ready) but
non-operational application. 130](#_Toc231370049)

[7.14... Mirror module ![](safekituserguideen_fichiers/image003.png)ALONE (Ready) - ![](safekituserguideen_fichiers/image007.png)WAIT/![](safekituserguideen_fichiers/image008.png)STOP
(NotReady) 130](#_Toc231370050)

[7.15... Farm module ![](safekituserguideen_fichiers/image003.png)UP(Ready)but problem
of load balancing in a farm.. 131](#_Toc231370051)

[7.15.1      Reported network load share are not coherent 131](#_Toc231370052)

[7.15.2      virtual IP address does not respond properly. 131](#_Toc231370053)

[7.16... Problem with the virtual IP after failover 132](#_Toc231370054)

[7.17... Problem after Boot 133](#_Toc231370055)

[7.18... Analysis from snapshots of the module. 133](#_Toc231370056)

[7.18.1      Module configuration files 134](#_Toc231370057)

[7.18.2      Module dump files. 135](#_Toc231370058)

[7.19... Problem with the size of SafeKit databases 138](#_Toc231370059)

[7.20... Problem for retrieving the certification authority certificate from
an external PKI 139](#_Toc231370060)

[7.20.1      Export CA certificate(s) from public certificates 139](#_Toc231370061)

[7.21... Issue with email sending by the SafeKit notification agent 141](#_Toc231370062)

[7.21.1      Failed to read or parse the configuration file. 142](#_Toc231370063)

[7.21.2      Email sending test blocked. 142](#_Toc231370064)

[7.21.3      Curl errors 142](#_Toc231370065)

[7.22... Issue with antivirus 144](#_Toc231370066)

[7.23... Issue with SafeKit kernel modules 144](#_Toc231370067)

[7.23.1      Mirror module with rfs filter in Windows. 144](#_Toc231370068)

[7.23.2      Farm module with vip kernel module in Linux. 144](#_Toc231370069)

[7.24... Troubleshooting VIP ↔ MAC resolution. 145](#_Toc231370070)

[7.24.1      Check cache entries. 145](#_Toc231370071)

[7.24.2      Force a new resolution. 145](#_Toc231370072)

[7.24.3      Observe Resolution Requests. 145](#_Toc231370073)

[7.25... Still in trouble. 146](#_Toc231370074)

[8.... SafeKit support 147](#_Toc231370075)

[9.... Command line interface. 149](#_Toc231370076)

[9.1..... Commands to control and setup SafeKit 149](#_Toc231370077)

[9.1.1       safeadmin
service. 149](#_Toc231370078)

[9.1.2       safewebserver web service. 150](#_Toc231370079)

[9.1.3       Email notification agent 151](#_Toc231370080)

[9.1.4       SNMP service. 151](#_Toc231370081)

[9.1.5       safecaserv
web service. 152](#_Toc231370082)

[9.2..... Command lines to configure and monitor the cluster 152](#_Toc231370083)

[9.3..... Command lines to control application modules 154](#_Toc231370084)

[9.4..... Command lines to monitor application modules 156](#_Toc231370085)

[9.5..... Command lines to configure application modules 157](#_Toc231370086)

[9.6..... Command lines for support 159](#_Toc231370087)

[9.6.1       Application module log. 159](#_Toc231370088)

[9.6.2       Application module snapshot 159](#_Toc231370089)

[9.6.3       Other commands 162](#_Toc231370090)

[9.7..... Command lines during the maintenance of the module application. 162](#_Toc231370091)

[9.7.1       Application module control for maintenance. 163](#_Toc231370092)

[9.7.2       Running the application without the module. 164](#_Toc231370093)

[9.8..... Command lines distributed across multiple SafeKit servers 164](#_Toc231370094)

[9.9..... Examples 166](#_Toc231370095)

[9.9.1       Local and distributed command. 166](#_Toc231370096)

[9.9.2       Cluster configuration with command line. 166](#_Toc231370097)

[9.9.3       Application module configuration with command line. 166](#_Toc231370098)

[9.9.4       Application module snapshot with command line. 167](#_Toc231370099)

[10. Advanced administration and setup. 169](#_Toc231370100)

[10.1... SafeKit environment variables and directories 169](#_Toc231370101)

[10.1.1      Global 169](#_Toc231370102)

[10.1.2      Application module. 170](#_Toc231370103)

[10.2... SafeKit services/daemons and communications 171](#_Toc231370104)

[10.2.1      SafeKit services 172](#_Toc231370105)

[10.2.2      SafeKit daemons per application module. 173](#_Toc231370106)

[10.3... Firewall settings 177](#_Toc231370107)

[10.3.1      Firewall settings in Linux. 177](#_Toc231370108)

[10.3.2      Firewall settings in Windows. 178](#_Toc231370109)

[10.4... Boot and shutdown setup in Windows 179](#_Toc231370110)

[10.4.1      Automatic procedure. 179](#_Toc231370111)

[10.4.2      Manual procedure. 179](#_Toc231370112)

[10.5... Linux Secure boot settings for SafeKit kernel modules 180](#_Toc231370113)

[10.6... Antivirus settings 181](#_Toc231370114)

[10.7... Encryption of application module communications 181](#_Toc231370115)

[10.7.1      Configuration with the SafeKit Web console. 182](#_Toc231370116)

[10.7.2      Configuration with the Command Line Interface. 182](#_Toc231370117)

[10.7.3      Advanced configuration. 183](#_Toc231370118)

[10.8... Encryption of sensitive files in SafeKit 184](#_Toc231370119)

[10.9... SafeKit web service settings 185](#_Toc231370120)

[10.9.1      Apache HTTP server 185](#_Toc231370121)

[10.9.2      Configuration files 187](#_Toc231370122)

[10.9.3      Connection ports configuration. 188](#_Toc231370123)

[10.9.4      HTTP/HTTPS and user authentication configuration. 189](#_Toc231370124)

[10.9.5      SafeKit API 189](#_Toc231370125)

[10.10. SafeKit email notification agent 192](#_Toc231370126)

[10.10.1    SafeKit notification agent configuration. 193](#_Toc231370127)

[10.10.2    SMTP client credentials setup for authentication. 194](#_Toc231370128)

[10.10.3    Email sending test 194](#_Toc231370129)

[10.10.4    SafeKit notification agent activation. 195](#_Toc231370130)

[10.11. SNMP monitoring. 195](#_Toc231370131)

[10.11.1    SNMP monitoring in Windows 195](#_Toc231370132)

[10.11.2    SNMP monitoring in Linux. 196](#_Toc231370133)

[10.11.3    The SafeKit MIB. 196](#_Toc231370134)

[10.12. Commands log of the SafeKit server 197](#_Toc231370135)

[10.13. SafeKit log messages in system log. 198](#_Toc231370136)

[11. Securing the SafeKit web service. 199](#_Toc231370137)

[11.1... Overview. 199](#_Toc231370138)

[11.1.1      Default setup. 200](#_Toc231370139)

[11.1.2      Predefined setups 200](#_Toc231370140)

[11.2... HTTP setup. 201](#_Toc231370141)

[11.2.1      Default setup. 201](#_Toc231370142)

[11.2.2      Unsecure setup based on identical role for all 203](#_Toc231370143)

[11.3... HTTPS setup. 204](#_Toc231370144)

[11.3.1      HTTPS setup using the SafeKit PKI 205](#_Toc231370145)

[11.3.2      HTTPS setup using an external PKI 213](#_Toc231370146)

[11.4... User authentication setup. 217](#_Toc231370147)

[11.4.1      File-based authentication setup. 217](#_Toc231370148)

[11.4.2      LDAP/AD authentication setup. 220](#_Toc231370149)

[11.4.3      OpenID authentication setup. 222](#_Toc231370150)

[12. Cluster.xml for the SafeKit
cluster configuration. 225](#_Toc231370151)

[12.1... Cluster.xml file. 225](#_Toc231370152)

[12.1.1      Cluster.xml example. 225](#_Toc231370153)

[12.1.2      Cluster.xml syntax. 226](#_Toc231370154)

[12.1.3      <lans>, <lan>, <node> attributes. 226](#_Toc231370155)

[12.2... SafeKit cluster Configuration. 228](#_Toc231370156)

[12.2.1      Configuration with the SafeKit web console. 228](#_Toc231370157)

[12.2.2      Configuration with command line. 229](#_Toc231370158)

[12.2.3      Configuration changes. 229](#_Toc231370159)

[13. Userconfig.xml for an application
module configuration. 231](#_Toc231370160)

[13.1... Time-based attributes 232](#_Toc231370161)

[13.1.1      Time-based attribute example. 232](#_Toc231370162)

[13.1.2      Time-based attribute syntax. 232](#_Toc231370163)

[13.2... Macros - <macro>. 233](#_Toc231370164)

[13.2.1      <macro> example. 233](#_Toc231370165)

[13.2.2      <macro> syntax. 233](#_Toc231370166)

[13.2.3      <macro> attributes 233](#_Toc231370167)

[13.3... Farm or mirror module - <service>. 234](#_Toc231370168)

[13.3.1      <service> example. 234](#_Toc231370169)

[13.3.2      <service> syntax. 234](#_Toc231370170)

[13.3.3      <service> attributes 235](#_Toc231370171)

[13.4... Heartbeats - <heart>, <heartbeat >. 237](#_Toc231370172)

[13.4.1      <heart> example. 238](#_Toc231370173)

[13.4.2      <heart> syntax. 238](#_Toc231370174)

[13.4.3      <heart>, <heartbeat > attributes. 238](#_Toc231370175)

[13.5... Farm topology - <farm>, <lan>. 240](#_Toc231370176)

[13.5.1      <farm> example. 240](#_Toc231370177)

[13.5.2      <farm> syntax. 241](#_Toc231370178)

[13.5.3      <farm>, <lan> attributes 241](#_Toc231370179)

[13.6... Virtual IP address - <vip>. 242](#_Toc231370180)

[13.6.1      <vip> example in a mirror module. 242](#_Toc231370181)

[13.6.2      <vip> example in a farm module. 243](#_Toc231370182)

[13.6.3      Alternative to <vip>. 243](#_Toc231370183)

[13.6.4      <vip> syntax. 244](#_Toc231370184)

[13.6.5      <vip><interface\_list>, <interface>, <virtual\_interface>,
<real\_interface>, <virtual\_addr> attributes. 245](#_Toc231370185)

[13.6.6      <loadbalancing\_list>, <group>, <cluster>,
<host> attributes. 249](#_Toc231370186)

[13.6.7      <vip> Load balancing description. 250](#_Toc231370187)

[13.7... File replication - <rfs>, <replicated>. 252](#_Toc231370188)

[13.7.1      <rfs> example. 252](#_Toc231370189)

[13.7.2      <rfs> syntax. 253](#_Toc231370190)

[13.7.3      <rfs>, <replicated> attributes 254](#_Toc231370191)

[13.7.4      <rfs> description. 262](#_Toc231370192)

[13.8... Module scripts - <user>, <var>. 271](#_Toc231370193)

[13.8.1      <user> example. 271](#_Toc231370194)

[13.8.2      <user> syntax. 271](#_Toc231370195)

[13.8.3      <user>, <var> attributes 271](#_Toc231370196)

[13.9... Virtual hostname - <vhost>, <virtualhostname>. 272](#_Toc231370197)

[13.9.1      <vhost> example. 272](#_Toc231370198)

[13.9.2      <vhost> syntax. 272](#_Toc231370199)

[13.9.3      <vhost>, <virtualhostname> attributes 273](#_Toc231370200)

[13.9.4      <vhost> description. 273](#_Toc231370201)

[13.10. Process or service monitoring - <errd>, <proc>. 274](#_Toc231370202)

[13.10.1    <errd> example. 274](#_Toc231370203)

[13.10.2    <errd> syntax. 275](#_Toc231370204)

[13.10.3    <errd>, <proc> attributes 276](#_Toc231370205)

[13.10.4    <errd> commands 280](#_Toc231370206)

[13.11. Checkers - <check>. 282](#_Toc231370207)

[13.11.1    <check> example. 282](#_Toc231370208)

[13.11.2    <check> syntax. 282](#_Toc231370209)

[13.11.3    <checker> description. 283](#_Toc231370210)

[13.12. TCP checker - <tcp>. 286](#_Toc231370211)

[13.12.1    <tcp> example. 286](#_Toc231370212)

[13.12.2    <tcp> syntax. 286](#_Toc231370213)

[13.12.3    <tcp> attributes. 287](#_Toc231370214)

[13.13. Ping checker - <ping>. 288](#_Toc231370215)

[13.13.1    <ping> example. 289](#_Toc231370216)

[13.13.2    <ping> syntax. 289](#_Toc231370217)

[13.13.3    <ping> attributes. 289](#_Toc231370218)

[13.14. Interface checker - <intf>. 291](#_Toc231370219)

[13.14.1    <intf> example. 291](#_Toc231370220)

[13.14.2    <intf> syntax. 292](#_Toc231370221)

[13.14.3    <intf> attributes. 292](#_Toc231370222)

[13.15. IP checker - <ip>. 292](#_Toc231370223)

[13.15.1    <ip> example. 292](#_Toc231370224)

[13.15.2    <ip> syntax. 293](#_Toc231370225)

[13.15.3    <ip> attributes. 293](#_Toc231370226)

[13.16. Custom checker - <custom>. 294](#_Toc231370227)

[13.16.1    <custom> example. 294](#_Toc231370228)

[13.16.2    <custom> syntax. 295](#_Toc231370229)

[13.16.3    <custom> attributes. 295](#_Toc231370230)

[13.17. Module checker - <module>. 297](#_Toc231370231)

[13.17.1    <module> example. 297](#_Toc231370232)

[13.17.2    <module> syntax. 297](#_Toc231370233)

[13.17.3    <module> attributes 298](#_Toc231370234)

[13.18. Splitbrain checker - <splitbrain>. 299](#_Toc231370235)

[13.18.1    <splitbrain> example. 299](#_Toc231370236)

[13.18.2    <splitbrain> syntax. 300](#_Toc231370237)

[13.18.3    <splitbrain> attributes 300](#_Toc231370238)

[13.19. Failover machine - <failover>. 301](#_Toc231370239)

[13.19.1    <failover> example. 301](#_Toc231370240)

[13.19.2    <failover> syntax. 302](#_Toc231370241)

[13.19.3    <failover> attributes. 302](#_Toc231370242)

[13.19.4    <failover> description. 303](#_Toc231370243)

[14. Scripts for an application module
configuration. 307](#_Toc231370244)

[14.1... List of scripts 307](#_Toc231370245)

[14.1.1      Start/stop scripts. 307](#_Toc231370246)

[14.1.2      Other scripts. 309](#_Toc231370247)

[14.2... Variables and arguments passed to scripts 309](#_Toc231370248)

[14.3... Scripts output 310](#_Toc231370249)

[14.3.1      Output into script log. 310](#_Toc231370250)

[14.3.2      Output into module log. 310](#_Toc231370251)

[14.4... Scripts execution automaton. 311](#_Toc231370252)

[14.5... SafeKit special commands for scripts 312](#_Toc231370253)

[14.5.1      Commands for Windows. 313](#_Toc231370254)

[14.5.2      Commands for Linux. 313](#_Toc231370255)

[14.5.3      Commands for Windows and Linux. 314](#_Toc231370256)

[15. Examples of application module
configurations. 317](#_Toc231370257)

[15.1... Mirror module example with mirror.safe. 318](#_Toc231370258)

[15.1.1      Cluster configuration with two networks. 318](#_Toc231370259)

[15.1.2      Mirror module configurations. 319](#_Toc231370260)

[15.1.3      Mirror module scripts. 321](#_Toc231370261)

[15.2... Farm module example with farm.safe. 323](#_Toc231370262)

[15.2.1      Cluster configuration with three nodes 323](#_Toc231370263)

[15.2.2      Farm module configurations 324](#_Toc231370264)

[15.2.3      Farm module scripts 331](#_Toc231370265)

[15.3... Macro and script variables example with hyperv.safe. 334](#_Toc231370266)

[15.3.1      Module configuration with macros and var 334](#_Toc231370267)

[15.3.2      Module scripts with var 335](#_Toc231370268)

[15.4... Process monitoring example with softerrd.safe. 336](#_Toc231370269)

[15.4.1      Module configuration with process monitoring. 336](#_Toc231370270)

[15.4.2      Advanced configuration of module scripts. 337](#_Toc231370271)

[15.5... TCP checker example. 339](#_Toc231370272)

[15.6... Ping checker example. 340](#_Toc231370273)

[15.7... Custom checker example with customchecker.safe. 342](#_Toc231370274)

[15.7.1      Module configuration with custom checker 342](#_Toc231370275)

[15.7.2      Advanced configuration of module checker script 344](#_Toc231370276)

[15.8... Split-brain checker example. 345](#_Toc231370277)

[15.9... Module checker examples 346](#_Toc231370278)

[15.9.1      Example of a farm module depending on a mirror module. 346](#_Toc231370279)

[15.9.2      Example with leader.safe and follower.safe. 348](#_Toc231370280)

[15.10. Interface checker example. 348](#_Toc231370281)

[15.11. IP checker example. 349](#_Toc231370282)

[15.12. Virtual hostname example with vhost.safe. 350](#_Toc231370283)

[15.12.1    Module configuration with a virtual hostname. 350](#_Toc231370284)

[15.12.2    Module scripts with a virtual hostname. 351](#_Toc231370285)

[16. SafeKit cluster in the cloud. 355](#_Toc231370286)

[16.1... SafeKit cluster in Amazon AWS. 355](#_Toc231370287)

[16.1.1      Mirror cluster in AWS. 356](#_Toc231370288)

[16.1.2      Farm cluster in AWS. 357](#_Toc231370289)

[16.2... SafeKit cluster in Microsoft Azure. 358](#_Toc231370290)

[16.2.1      Mirror cluster in Azure. 359](#_Toc231370291)

[16.2.2      Farm cluster in Azure. 361](#_Toc231370292)

[16.3... SafeKit cluster in Google GCP. 362](#_Toc231370293)

[16.3.1      Mirror cluster in GCP. 363](#_Toc231370294)

[16.3.2      Farm cluster in GCP. 364](#_Toc231370295)

[17. Third-Party Software. 367](#_Toc231370296)

[Log Messages Index. 371](#_Toc231370297)

[Index. 375](#_Toc231370298)