Documentation

Install, Uninstall and Update SADMIN

Name … Script Description
How-to install SADMIN setup.sh/sadm_setup.py SADMIN installation page
How-to uninstall SADMIN sadm_uninstall.sh Uninstall procedure page
List/Install requirements sadm_requirements.sh View/Install packages required by SADMIN
How-to update client(s) sadm_push_sadmin.sh Push SADMIN version to one or all actives clients
How-to update SADMIN server Method 1 or 2 How-to update to latest version of SADMIN
Directories structure Image SADMIN Full directories structure
Support request sadm_support_request.sh Submit an enhancement or a support request

Back to the top

Using the web interface

Name … Description
How-to add a client How-to add a client to SADMIN inventory
How-to remove a client How-to remove a client from SADMIN inventory
How-to schedule O/S update Schedule O/S update with Web Interface
How-to schedule a ReaR Image backup Schedule ReaR backup via theweb interface
How-to create a daily backup Daily backup what you need with custom retention

Back to the top

Command line tools

Name … Script Description
sdf sadm_df.sh Customize version of ‘df’ command
srch sadm_show_rch.sh Show Result History files (.rch) from all systems
sview sadm_sysmon_tui.pl System monitor viewer from command line
sadm sadm_ui.sh System Administration Menu
smon sadm_sysmon_cli.sh Run SysMon and view the report file and script(s) error(s)
Startup/Shutdown script sadm_service_ctrl.sh Enable, disable system startup/shutdown script

Back to the top

Writing your own scripts

Name … Script Description
Quick-Intro Templates/Wrapper Introduction to template & wrapper
How-to use the shell script template sadm_template.sh Using SADMIN shell script template
How-to use the python template sadm_template.py Using SADMIN python script template
How-to use the menu template sadm_template_menu.sh Using SADMIN shell menu template
How-to use the script wrapper sadm_wrapper.sh Use the wrapper to run your existing scripts
SADMIN Shell Library Doc. sadmlib_std.sh SADMIN standard shell library
SADMIN Shell Library Demo sadmlib_std_demo.sh SADMIN Shell library demonstrator
SADMIN Python Library Doc. sadmlib_std.py SADMIN standard python library
SADMIN Python Library Demo sadmlib_std_demo.py SADMIN Python library demonstrator
Library Code Section Code to include Minimal code for using SADMIN library
SADMIN Menu Builder Library sadmlib_screen.sh Library use to build shell menu

Back to the top

Configuration files

Name Location Description
Main config file $SADMIN/cfg/sadmin.cfg SADMIN main configuration file
SysMon config $SADMIN/cfg/${HOSTNAME}.smon System Monitor configuration file
SysInfo file $SADMIN/dat/dr/$hostname_sysinfo.txt) Hardware/Software info about system file
Alert Group File $SADMIN/cfg/alert_group.cfg) Alert group definition file
Slack config $SADMIN/cfg/alert_slack.cfg) Slack group webhook definition file
Server crontab /etc/crontab.d/sadm_server Run everything that keep SADMIN running smoothly
Client crontab /etc/crontab.d/sadm_client Collect perf., sysinfo, run sysmon & housekeeping

Back to the top

System Monitor

View all your servers alerts from the web interface or on the command line using sview.

Name … Script Description
smon smon (sadm_sysmon_cli.sh) Run SysMon and see the report file
sview sview (sadm_sysmon_tui.pl) Command line SysMon viewer
System Monitor sadm_sysmon.pl SADMIN System Monitor (SysMon)
System Monitor Watcher sadm_nmon_watcher.sh System Monitor Watcher
System Monitor config. file $SADMIN/cfg/${HOSTNAME}.smon System Monitor configuration file
Pull log,rpt ans rch from clients sadm_fetch_clients.sh Pull .rch/.log/.rpt from clients
How-to setup SMS notification How-to How-to use SMS alerting system
How-to create a Slack workspace How-to Creating a Slack Workspace
How-to create Slack channel How-to Configure Slack Channel & App.
How-to use alerting system How-to Understanding the alerting system

Back to the top

Backups

Name … Script Description
Daily backup script sadm_backup.sh Backup based on the backup list content
Save filesystem metadata sadm_dr_savefs.sh Save filesystems metadata (use by sadm_dr_recreatefs.sh)
Recreate filesystems sadm_dr_recreatefs.sh Recreate filesystem saved by ‘sadm_dr_savefs.sh
Backup database sadm_backupdb.sh Backup one or all MySQL/MariaDB databases
Backup image sadm_rear_backup.sh Create image backup of the system to a NFS server

Back to the top

O/S Update Tools

Name … Script Description
How-to schedule O/S update   Schedule O/S update with Web Interface
Update current system O/S sadm_osupdate.sh Run O/S update on the current system
Update O/S on remote system sadm_osupdate_starter.sh Run the O/S update to selected remote system

Back to the top

Server daily start of day scripts

Name … Script Description
Daily start of day script sadm_server-sunrise.sh Main script that run the 6 scripts below
1. Dir. housekeeping sadm_server_houskeeping.sh Set permission on Web interface & crontab files
2. Collect clients data sadm_daily_farm_fetch.sh Collect Hard./Soft./Perf. data from clients
3. Update database sadm_database_update.py Update database using Sysinfo file
4. Update perf. database sadm_nmon_rrd_update.sh Daily performance graphic database update
5. Scan selected subnet sadm_subnet-lookup.py Scan selected subnet & update database
6. Backup SADMIN database sadm_backupdb.sh Backup SADMIN database
Email Sysadmin daily report sadm_daily_report Produce and email monitoring daily reports

Back to the top

Client daily end of day scripts

Name … Script Description
Daily end of day script sadm_client_sunset.sh Main script that run the 4 scripts below
1. Client housekeeping sadm_client_housekeeping.sh Purge old log,rch,nmon files & check permission
2. Create sysinfo file sadm_create_sysinfo.sh Collect hardware & software info about system
3. Save lvm metadata sadm_dr_savefs.sh Save lvm metadata (use by sadm_dr_recreatefs.sh)
4. Produce Sysinfo HTML sadm_cfg2html.sh Get Sysinfo & creates HTML page

Back to the top