Professional Documents
Culture Documents
Salsa 8 Backup And-Restore
Salsa 8 Backup And-Restore
Salsa Solution
Customer Care
13/03/2014
TN-0100200-14_Salsa_General_Backup_and Restore
TN-0100200-14_Salsa_General_Backup_and Restore
Revision history
Version Date Changes / Comments
1.0 31/03/2014 Initial version
Compatibility
System ip|boss ip|reporter ip|agent ip|reporter web ip|export
Version >7.1 >7.1 >7.1 - >7.1 -
Infovista
4.3 4.3 4.3 4.3
release
OS Windows 2008 R2 and Linux RHEL > 5.6
Prerequisite
Technical Title
Note
www.ipanematech.com 2
TN-0100200-14_Salsa_General_Backup_and Restore
TABLE OF CONTENTS
1. Objective ........................................................................................................................ 4
1.1. Scope ...................................................................................................................... 4
2. Backup ........................................................................................................................... 5
2.1. Salsa 7 .................................................................................................................... 5
2.1.1. License file ....................................................................................................... 5
2.1.2. ip|boss.............................................................................................................. 5
2.1.3. ip|uniboss ......................................................................................................... 7
2.1.4. Dashboard ....................................................................................................... 9
2.1.5. Salsa Weberver...............................................................................................10
2.2. Salsa 8 ...................................................................................................................10
2.2.1. Backup summary ............................................................................................11
2.3. Reporting ...............................................................................................................12
2.3.1. IP|Reporter Server (VF0 and VF4 mode) ........................................................12
2.3.2. IP|Reporter LoadBalancer (VF4 mode only) ....................................................22
2.4. Backup Summary ...................................................................................................34
3. Restore .........................................................................................................................35
3.1. Salsa ......................................................................................................................35
3.1.1. Restore procedure can be differentiated in two categories: .............................35
3.1.2. Partial Restore ................................................................................................35
3.1.3. Full restore ......................................................................................................36
3.1.4. IP|Reporter Server (VF0 and VF4 mode) ........................................................38
3.1.5. IP|Reporter LoadBalancer (VF4 mode only) ....................................................39
www.ipanematech.com 3
TN-0100200-14_Salsa_General_Backup_and Restore
1. Objective
The purpose of this document is to give the procedures to Backup and Restore the whole
Salsa Solution (IP|Boss, Dashboard, Reporting).
Backups are necessary for a Disaster and Recovery Plan (DRP) as well as standard
maintenance and operations while trying to recover from a misconfiguration and or loss of
configuration.
1.1. Scope
The scope of this document only covers the following salsa components:
License file
ip|boss
Server configuration
Domains configuration
ip|uniboss
Server configuration
LDAP authentication service
Web applications
Dashboard
Salsa webserver
Salsa V8
IP|reporter LoadBalancer (VistaMart)
IP| Reporter Server
Cockpit configuration
Local configuration
www.ipanematech.com 4
TN-0100200-14_Salsa_General_Backup_and Restore
2. Backup
2.1. Salsa 7
2.1.2. ip|boss
No domains to back up
Uniboss domains configuration files
www.ipanematech.com 5
TN-0100200-14_Salsa_General_Backup_and Restore
~/ipboss/server/domains/uni_boss/config/__active__.ipmuniconf
~/ipboss/server/domains/uni_boss/conf/platform/license.ipmsys
General server configuration files
Domain configuration files should have been already saved on a daily basis, no additional
files to back up at this stage.
Uniboss domains configuration files
www.ipanematech.com 6
TN-0100200-14_Salsa_General_Backup_and Restore
2.1.3. ip|uniboss
The only file that should be backed up is the license file provided by Ipanema support.
Web server files
www.ipanematech.com 7
TN-0100200-14_Salsa_General_Backup_and Restore
LDAP directory should be saved on a daily basis, following directory must be backed up:
~/apacheDS/instances.
ip|uniboss server configuration files
Domains configuration should be saved on a daily basis, following directory must be backed
up: ~/server/conf
Web server files
As the LDAP directory should be saved on a daily basis there is no need to add extra
backup.
ip|uniboss server configuration files
As the Domains configuration should be saved on a daily basis there is no need to add extra
backup.
Web server files
In some occasion there can be some specific tuning for the Web Apps provided by Ipanema.
If there is any specific tuning of the web apps the tuned web apps should be backed up.
Otherwise there is no need to backup any file. Web apps can be found in the following
directory: ~/web_server/webapps.
Please refer to Ipanema support for a tuning, backup/restore procedure for web apps.
www.ipanematech.com 8
TN-0100200-14_Salsa_General_Backup_and Restore
2.1.4. Dashboard
After first installation a zip file called data.zip located in ~/ipboss/server/postgresql/ contains
the initial configuration.
The database configuration files can also be backup:
~/ipboss/server/postgresql/data.zip
~/ipboss/server/pgbouncer/conf/
Real time information database is used to store for all domains 3 hour historical information
thus there is no need to perform daily backups.
In some occasion there can be some specific tuning for the dashboard provided by Ipanema.
If there is any specific tuning done it should be backup on a regular basis. Otherwise there is
no need to backup any file.
~/ipboss/server/pgbouncer/conf
~/ipboss/server/postgresql/data/ipm_database_users.txt
~/ipboss/server/postgresql/data/ipm_pg_bouncer.ini
~/ipboss/server/postgresql/data/postgresql.conf
~/ipboss/server/postgresql/data/postmaster.opts
www.ipanematech.com 9
TN-0100200-14_Salsa_General_Backup_and Restore
In some occasion there can be some specific tuning for the Salsa Webserver provided by
Ipanema. If there is any specific tuning (Certificate/Customization of the Portal…) done it
should be backed up. Otherwise there is no need to backup any file.
~/apache/conf/
2.2. Salsa 8
Since Salsa Version 8, a backup script is available and is doing all the previous salsa
components files backup and some additional.
This script is located in ~/salsa/tools
You can launch this script for initial backup and Maintenance or exploitation backup, and
schedule a task (Task scheduler or Cron job) so that it can be launched on a regular basis.
It will create a zip file and the path of this Zip File has to be outside the ~/salsa directory
For a multi-part installation, the tasks have to be scheduled at the same exact same
time.
The command to launch is
www.ipanematech.com 10
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 11
TN-0100200-14_Salsa_General_Backup_and Restore
2.3. Reporting
100GB/day 63GB/day
www.ipanematech.com 12
TN-0100200-14_Salsa_General_Backup_and Restore
2.3.1.2.1. Description
The Osbackup tool of Infovista can be used to perform a backup of the database on window
2008, Solaris (8, 9, 10) and Linux RHEL platform.
Ipanema highly recommend using Point-in-time copy for backups if supported in your
environment, OSBackup has a notable impact on service performance.
The backup can be done online (you don't need to stop the InfoVista services).
To backup the database, we suggest the following batch file that you should execute by the
Windows Task scheduler every day at 03:00am.
Create a dedicated directory (if possible on a separate disk).
Check the result regularly.
move /Y ipm_backup.bck ipm_backup.old
osbackup -f ipm_backup.bck "C:\Program Files\InfoVista\Essentials\data\manager.db"
"C:\Program Files\InfoVista\Essentials\data\collector.db"
2.3.1.2.2. Remarks
Depending on the size of the collector database, "osbackup" task could be long and impact
InfoVista service by:
Outages in reports for both cases,
Reports are not available or very long before being displayed.
2.3.1.3.1. Compatibility
Point-in-time copy (snapshot based) is possible in the following environments:
Solaris 10/sparc with UFS filesystem (uses Oracle’s fssnap tool)
Linux RHEL 5 or higher with LVM (uses LVM snapshots)
Windows 2008 in 64 bits mode does not support this method for backups
2.3.1.3.2. Overview
The implementation of the backup tool on UNIX requires an application which InfoVista
provides called ‘IVBackup’, which automates the backup process.
www.ipanematech.com 13
TN-0100200-14_Salsa_General_Backup_and Restore
This application supports snapshots performed by fssnap (Solaris) on the UFS file system,
flashsnap (Veritas) on VxFS file system and lvcreate on Linux LVM partitions. You have to
run the application locally on the machine on which InfoVista is running
IVBackup tool automatically performs the following actions:
Server checkpoint of the IVServer instance
Perform a snapshot of the manager and collector databases
The identification of the snapshot tool (Solaris UFS or Veritas VxFS) is based on the
database path.
With Solaris UFS or Linux LVM filesystems; IVBackup creates the snapshot with the
provided <backingstore> (<backingstore>/ivbackup.<pid>).
On Veritas file system, IVBackup creates the snapshot with a default checkpoint name
(ivbackup.checkpoint.<pid>).
2.3.1.3.3. Usage
ivbackup [-i instance] [-u username] [-p password] [-b backingstore]
[-m mountpoint] [-t timeout] [-v] [-gzip] [-block blocksize] -o
backup
Connection:
-i instance: instance identification (default "")
Is the identifier of the InfoVista Server instance you wish to backup. It can be identified
by name (i.e.: iv1) or manager:collector:browser endpoint ports (10000:10001:10002)
-u username: username (default administrator)
www.ipanematech.com 14
TN-0100200-14_Salsa_General_Backup_and Restore
Options:
-b backingstore: ufs backing store path (default "<backup
path>/ivbackup.<pid>")
This option is only necessary when InfoVista databases are stored on a UFS file
system. The partition for which the backingstore path is provided should have enough
free space to store a copy of the databases.
-block blocksize (default: 2M, unit: multiple of 512 bytes, min: 512 bytes, max: 64
megabytes)
This option is used to specify the chunksize. The chunksize is important for
performance. The default value should be efficient in most cases. If the specified
block size is smaller than 32k, the snapshot is created with 32k.
-m mountpoint: snapshot/checkpoint mount point (default "<backup
path>/ivbackup.mnt.<pid>")
This is the mount point used to mount the partition on which the snapshot is stored. If
this one does not exist, IVBackup fails. If this option is not set, IVBackup creates a
temporary mount point and when releasing the checkpoint, the mount point is
removed.
-t timeout: checkpoint timeout (default 3600s)
The database checkpoint is release right after the snapshot (a few seconds) this
timeout is only reached when an issue is encountered.
-v: verbose mode
To use this option, gzip should be available in /usr/bin directory. If not, IVBackup fails.
-o backup: path of target tar file containing both Manager and Collector databases
Full path of target tar archive containing both Manager and Collector databases
Note: When using the backup tool, bear in mind the following points:
If IVBackup is interrupted (e.g. control-C), any on-going database checkpoint is
automatically released and any existing snapshot, backing store and mount point are also
removed.
Timeout must be greater than 15 seconds, in order to let enough time to perform the
snapshot.
The backingstore must be located outside the file system where the databases are stored.
If not, you will get a fssnap error: snapshot error: Invalid backing file path.
When using the -gzip option, IVBackup checks if /usr/bin/gzip is present. If not, IVBackup
aborts.
IVbackup emits a warning if destination file system is mounted with forcedirectio (Solaris)
www.ipanematech.com 15
TN-0100200-14_Salsa_General_Backup_and Restore
2.3.1.3.4. Example
You can back up InfoVista databases for IV Server instance"iv1":
ivbackup -i iv1 -u administrator -p "" -v -gzip -o
/bkp/IV1Backup10252004
2.3.1.4.1. Configuration
You first need to login the VistaCockpit management console using administrator credentials.
Once connected, select the task tab and right-click on the “Workflows on schedule” to select
the “New Workflow on schedule” option.
www.ipanematech.com 16
TN-0100200-14_Salsa_General_Backup_and Restore
The new workflow should now appear in the left part of the window. We now need to set:
What we want to do, and when we want to do it.
Once the workflow schedule is defined, select the ‘‘Tasks’’ tab to define the actions to be
carried out.
Create the Backup Task
After choosing a name for the task, clicking in the “Command” field will open a list of preset
tasks.
Select ‘‘Backup and compress Manager and Collector databases’’ from the IV Server branch.
Some specific environments may require not compressing the backups (compressed NTFS
file systems for example).
www.ipanematech.com 17
TN-0100200-14_Salsa_General_Backup_and Restore
Once the Command has been selected, choose the Target (IVServers)
A single task can backup multiple server and multiple instances. You may also create
multiple tasks for each of the servers/instances. Using the “Predecessors” field, you will be
able to set the order in which the tasks will be ran.
Note that if there are several instances among a server group spread on several IP|Reporter
servers, a separate task has to be launched.
For example, if you have iv1 on server1 and iv1 on server 2, the backup task will try to do in
parallel 2 backups of iv1 instance and it will fail.
www.ipanematech.com 18
TN-0100200-14_Salsa_General_Backup_and Restore
The last step that needs to be done is setting the precise backup command that will be ran
on the servers.
Select the “Parameters” tab in the lower right part of the window. Two fields need to be filled:
Backup Directory: This is the directory name, local to the InfoVista server, where the
backup file will be stored.
Backup File: This is the filename that will be used for the backup files. VistaCockpit provides
some variable substitutions: $(target:Jmx.Info.InstanceName) InfoVista instance
name; $(Date|yyyy_MM_dd) current date.
In our example, the generated backup file will be the following:
c:\InfoVista\backups\backup_all_iv1_2013_10_31
Important: You need to design a naming convention according to the chosen schedule:
The default backup filename suggested by VistaCockpit will create a new backup file every
day: This will fill up the disk
Choosing a name that does not contain the date will overwrite the older backup each time: In
the event of a server failure while the backup is running, you may not have any valid data to
restore from.
www.ipanematech.com 19
TN-0100200-14_Salsa_General_Backup_and Restore
Umount_Drive Task: task that will launch the script to unmount the network share from the
IP|reporter server (The script has to be located on the IP|reporter server)
Mount_drive Task:
Create the new task and select the command to launch (Execute a script).
In parameter, give the absolute path of the mount script in “Program” field
In our example, the script is mount.bat and is located in C:\Users\Administrator\Desktop on
the IP|Reporter server “Salsa71”.
www.ipanematech.com 20
TN-0100200-14_Salsa_General_Backup_and Restore
Backup task
The backup task is the same as we describe previously except that we should add a
“Predecessor” task Mount_drive.
The Running Condition should be ON_SUCCESS so that the Backup can’t be launch if the
Share is not mounted.
Umount_drive task
Repeat the Mount_drive task but configure the Backup task as predecessor.
The Running condition can be left to ALWAYS as the network share should be disconnected
any way.
www.ipanematech.com 21
TN-0100200-14_Salsa_General_Backup_and Restore
This apply only in case the Backup disk is local to the InfoVista Server.
www.ipanematech.com 22
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 23
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 24
TN-0100200-14_Salsa_General_Backup_and Restore
The following information needs to be given for the configuration wizard, to be able to
connect to the database :
Host Name: Database server to connect to (usually the systems primary IP address).
DB Port Number: Unless it has been customized, leave the default value untouched.
SID: The VistaMart database name (IVDB by default).
User Name: Oracle administrator username: sys
Password: Password set during the initial installation for the Oracle administration
account.
The following dialog screen sets up the schedule for the automatic backups. We recommend
using the “Standard” Oracle backup profile for the VistaMart database automated backups.
Backups should be done daily, 7 days a week.
The scheduled time will depend on the time at which external backup program is ran.
Recovery area size should be set to a value equal or higher than the one indicated during the
initial system sizing. It should not exceed the available backup disk space.
www.ipanematech.com 25
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 26
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 27
TN-0100200-14_Salsa_General_Backup_and Restore
VM_DFULL_BCK_JOB TRUE
This means the backup job is scheduled and will be executed next time it's scheduled for.
On the other hand if you get the following results:
VM_DFULL_BCK_JOB FALSE
this means the backup job is scheduled but not active (There are kown issues where the
backup job does not get activated after you have run the procedure).
If this is the case please, contact Ipanema Support or refer to the technical note TN-
0200155-06_Check_automatic_Oracle_DB_backups_in_VF4_mode.pdf ).
www.ipanematech.com 28
TN-0100200-14_Salsa_General_Backup_and Restore
Verify that automatic archival is Enabled in the results displayed using the above
command.
Finally check recovery area path and size in this last command:
www.ipanematech.com 29
TN-0100200-14_Salsa_General_Backup_and Restore
Disable backups using the VistaMart database manager (cf 2.2.1.3). You must go through all
the configuration screens described earlier, before you can access the screen to disable
backups.
IMPORTANT: We strongly recommend stopping both VistaMart application and
computation services at this point.
Under UNIX, this might look like (Axe corresponding to the recovery area in italics):
<Axes>
<Axe shared="false" raid="Unknown" mount="/opt/InfoVista" id="1">
<Size value="30.0" unit="GB"/>
</Axe>
<Axe shared="false" raid="Unknown" mount="/opt/recovery2" id="2">
<Size value="20.0" unit="GB"/>
</Axe>
</Axes>
www.ipanematech.com 30
TN-0100200-14_Salsa_General_Backup_and Restore
In a Windows environment:
<Axe shared="true" raid="1" mount="F:/backuptest/" id="4">
<Size value="100.0" unit="GB"/>
</Axe>
We will now change the location for the block tracking file (we will need to stop Oracle at this
point):
Copy the tracking file from the former to the new recovery area:
UNIX:
cp /recovery/InfoVista/oradata/IVDB/db_change_tracking.tr \
/opt/recovery2/InfoVista/oradata/IVDB
copy d:\InfoVista\oradata\IVDB\DB_CHANGE_TRACKING.TR
F:\backuptest\InfoVista\oradata\IVDB
www.ipanematech.com 31
TN-0100200-14_Salsa_General_Backup_and Restore
SQL> exit
You can now restart the VistaMart database configuration wizard and re-enable the Oracle
database backups (this will require an Oracle restart). As said earlier, preferably VistaMart
services should be stopped at this point.
Check that changes have been taken into account by typing the three commands in bold
and check that the output reflects the new settings:
C:\Documents and Settings\Administrator>sqlplus sys/ipanema as sysdba
SQL*Plus: Release 10.2.0.4.0 - Production on Mon Nov 8 17:49:06 2010
Copyright (c) 1982, 2007, Oracle. All Rights Reserved.
Connected to:
Oracle Database 10g Enterprise Edition Release 10.2.0.4.0 - Production
With the Partitioning, OLAP, Data Mining and Real Application Testing
Options
FILENAME
--------------------------------------------------------------------------
------
STATUS
----------
F:\BACKUPTEST\INFOVISTA\ORADATA\IVDB\DB_CHANGE_TRACKING.TR
ENABLED
www.ipanematech.com 32
TN-0100200-14_Salsa_General_Backup_and Restore
This last command should output the last backups recorded on the system. The last one,
should be the manual backup you’ve just made:
The procedure is finished. You have move VistaMart Oracle database location.
www.ipanematech.com 33
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 34
TN-0100200-14_Salsa_General_Backup_and Restore
3. Restore
3.1. Salsa
3.1.2.1. Salsa V7
www.ipanematech.com 35
TN-0100200-14_Salsa_General_Backup_and Restore
3.1.2.1.4. Salsa V8
From the Zip file generated backup.zip, you can extract the Previous files and restore them
as for v7 version
3.1.3.1. Salsa V7
www.ipanematech.com 36
TN-0100200-14_Salsa_General_Backup_and Restore
Once the services are stopped restore all backup files to their original path according to the
following table:
Files
~/ipboss/server/pgbouncer/conf/
~/ipboss/server/postgresql/data/
~/ipboss/server/conf/ipm_domains.conf
~/ipboss/server/conf/ipboss.conf
~/ipboss/server/conf/reports_desc.ipmsys
~/ipboss/server/domains/
~/uniboss/apacheDS/instances.
~/uniboss/server/conf
~/uniboss/web_server/webapps.
X* File restore is only needed if one or more web apps have been tuned.
.After restoring all the files Salsa service should be re started.
3.1.3.1.3. Salsa V8
As for Backup, this version provides a restore script that will restore all the Backup files at the
same place.
To restore a backup, the current installation and the installation when the backup has been
done must verify the following criterias:
the product version is the same
the domain location is the same
the list of packages are the same (web server, ip|boss, ip|uniboss)
The restore script must be executed with an administrator account.
The restore script can be executed while services are started or stopped. If they are started,
they will be stopped at the beginning of the script and restarted at the end. You can use the
parameter "-forceStart" to force the the start of salsa services at the end.
For a multi-part installation, the tasks have to be scheduled at the same exact same
time.
This script is located in ~/salsa/tools
The command to launch is:
www.ipanematech.com 37
TN-0100200-14_Salsa_General_Backup_and Restore
www.ipanematech.com 38
TN-0100200-14_Salsa_General_Backup_and Restore
Note:
The arguments are given with spaces.
The paths to collector and manages databases is specified twice as one indicates source
and the other destination. For an example if you want to extract from the backup to different
location the command would be
osrestore,exe –f C:\Program Files\the_path_to_backup_folder\ipm.backup.bkf C:\Program Files
InfoVista\Essentials\data\manager.db F:\manager.db C:\Program
Files\InfoVista\Essentials\data\collector.db F:\collector.db
Before launching the full restore script, Oracle REDO LOGS have to be removed from
the filesystem in order to be able to import the Oracle backups. This is mandatory if
the backups come from a different Oracle server.
Once REDO LOGS files have been removed you can proceed to the next step.
Note that, you’ll need to change the path of the recovery area, according to your local setup.
On a Windows deployment this can be done using the following command:
Open a Command Line Window
www.ipanematech.com 39
TN-0100200-14_Salsa_General_Backup_and Restore
Go to [INSTALL_BASE_DIR]\InfoVista\VistaMart\dbmgr\bin
dbrecoveryfull.bat -Ddatabase.syspw="oracle"
-Ddatabase.recoveryarea.dir="d://InfoVista/oradata/IVDB/restore"
You need to change the path of the recovery area, according to your local setup.
On a Linux deployment this can be done using the following command:
[root@LB71_srv2~]# su oracle
sh-3.2$ export ORACLE_SID=IVDB
sh-3.2$ export ORACLE_HOME=/opt/InfoVista/oracle/product/11.2.0.3
sh-3.2$ export PATH=$PATH:/opt/InfoVista/VistaMart/bin:$ORACLE_HOME/bin
sh-3.2$ cd /opt/InfoVista/VistaMart/dbmgr/bin/
sh-3.2$ ./dbrecoveryfull.sh -Ddatabase.syspw=”oracle"
-Ddatabase.recoveryarea.dir=”/opt/backups/InfoVista/oradata/IVDB/restore"
You need to change the path of the recovery area, according to your local se
Once the script execution is finished you’ll get some warnings messages that may be
ignored. To restart the database you’ll need to stop the database, start the database andalter
the database by resetting the REDO LOGS. This will be done using the following command:
Connected to:
Oracle Database 11g Enterprise Edition Release 11.2.0.3.0 - 64bit Production
With the Partitioning and Real Application Testing options
Database altered.
SQL>exit
www.ipanematech.com 40
www.ipanematech.com | Beyond the Network…
Ipanema provides enterprises with a direct connection between application performance and their
business requirements. With Ipanema Technologies, enterprises automatically understand which
applications use the network and deliver guaranteed performance to each user. Enterprises can
support their strategic IT transformations (like cloud computing and Unified Communications) and
control Internet growth while reducing their IT expenses. Ipanema’s customers range from mid-
sized companies to enterprises with 1,000s of sites. For Enterprises, Ipanema is available as a
Product through an international network of Certified Channel Partners, and as a Service through
Managed Service Providers and Telecom Operators' Managed Services. For SMBs, Ipanema is
available as a Service through Ipanema's AppsWork™ Authorized Partners network.
Copyright © 2012, Ipanema Technologies - All rights reserved. Ipanema and the Ipanema logo
are registered trademarks of Ipanema Technologies. The other registered trademarks and product
names mentioned in this document are the property of their respective owners.