1. EAGLE Database Administration - System Management User's Guide
  2. Remote Database Backup and Restore Procedures

D Remote Database Backup and Restore Procedures

Appendix D, Remote Database Backup and Restore Procedures, describes how to perform a backup of the database to the FTP server, and how to restore the database from the FTP server.

D.1 Introduction

This appendix contains the procedures for performing a backup of the database to the FTP server and to restore a database from the FTP server using the chg-db command.

To backup the database, the chg-db command uses these parameters.
  • action=backup - perform a backup of the database.
  • dest=server - the destination of the backup operation, the FTP server.
To restore the database, the chg-db command uses these parameters.
  • action=restore - restore a previously backed up database.
  • src=server - the source of the database that is being restored, the FTP server.
  • file - the name of the TAR file on the DB FTP server that contains database that is being restored.

A removable cartridge is not required and cannot be used to backup the database to the FTP server or to restore a database from the FTP server.

To perform a backup of the database to the FTP server or to restore the database from the FTP server, these items must be provisioned in the database.

  • An E5-IPSM - perform the procedure Adding an E5-IPSM.

    Note:

    As of Release 46.5, the E5-IPSM card and its functionality is replaced by the E5-ENET-B (p/n 870-2971-01) or SLIC (p/n 7094646) card. Any references to E5-IPSM and the 870-2877-01 part number should be replaced by the 46.5 and greater card and part number.
  • An FTP server for the DB application - perform the procedure Adding an FTP Server.
When the database is backed up to the FTP server, the database on the active partition of the active TDM is packed and compressed into a TAR file andsends the file to the FTP server through an E5-IPSM. Figure D-1 illustrates this action.

Figure D-1 Backup of the Database to the FTP Server

img/remote_backup_diagram_114145.jpg
When the database is restored from the FTP server, the TAR that contains the database that is being restored is retrieved by EAGLE through an E5-IPSM. The TAR file is unpacked and uncompressed and the database files are placed on the active partition of both TDMs. Figure D-2 illustrates this action. The EAGLE must be reinitialized to load the restored database to all the cards.

Figure D-2 Restoring the Database from the FTP Server

img/remote_restore_diagram_114145.jpg

To perform a backup of the database to the FTP server, perform the procedure Making a Backup of the Database to the FTP Server.

To restore the database from the FTP server, perform the procedure Restoring the Database from the FTP Server.

D.2 Making a Backup of the Database to the FTP Server

This procedure is used to make a backup of the database to FTP server using the chg-db command with these parameters.

  • :action=backup
  • :dest=server

The database in the active partition of the active MASP (FD CRNT) must be coherent. The status of the database is shown in the rept-stat-db command. For more information on verifying the database, refer to Verifying the Database.

Note:

As of Release 46.5, the E5-IPSM card and its functionality is replaced by the E5-ENET-B (p/n 870-2971-01) or SLIC (p/n 7094646) card. Any references to E5-IPSM and the 870-2877-01 part number should be replaced by the 46.5 and greater card and part number.

The EAGLE must contain at least one E5-IPSM and an FTP server for the DB application. The rept-stat-gpl command with the appl=ips parameter displays the E5-IPSMs and IPSMs that are in the database. E5-IPSMs are shown by the entry IPSHC in the GPL column of the rept-stat-gpl output. IPSMs are shown by the entry IPS in the GPL column of the rept-stat-gpl output. The rtrv-ftp-serv command shows the FTP servers that are configured. E5-IPSMs can be added by performing the procedure Adding an E5-IPSM. FTP servers can be added by performing the procedure Adding an FTP Server.

When a backup of the database to the FTP server is performed, A file containing the database is created with the following naming convention is created:

“CLLI string”-“Release number string”-“yymmddhh”.tar.gz

The CLLI string is the CLLI value shown in the output header. The release number string is the release number shown in the output header. If the archbldid option, shown in the rtrv-stpopts output, is set to yes, the release number string contains the build number instead of the release number. If you wish to change the archbldid option, perform the procedure Configuring the Archive Build ID Option. The string yymmddhh is the year (yy - 2 digits), the month (mm), the day (dd), and the hour (hh) that the backup was performed. For example, the file name for a backup performed on September 26, 2008 at 12 noon would be: rlghncxa03w-39.2.0-08092612.tar.gz. This file name will be needed to restore the database from the FTP server. The file name for the backup can contain a maximum of 39 alphanumeric characters.

  1. Verify that the database in the active partition of the active MASP (FDCRNT) is coherent using the rept-stat-db command.

    This is an example of the possible output. 

    
rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0
DATABASE STATUS: >> OK <<
        TDM 1114 ( STDBY)                 TDM 1116 ( ACTV )
         C  LEVEL     TIME LAST BACKUP     C  LEVEL     TIME LAST BACKUP
         - -------- ---------------------  - -------- ---------------------
FD BKUP  Y       35 04-06-01 10:19:18 GMT  Y       35 04-06-01 10:19:18 GMT
FD CRNT  Y      106                        Y      106           
         MDAL 1117
         - --------
RD BKUP  -    -         -        -

    If E5-based control cards are installed in the EAGLE, this is an example of the output.

    
rlghncxa03w 09-03-01 16:07:48 GMT  EAGLE5 40.1.0
DATABASE STATUS: >> OK <<
        TDM 1114 ( STDBY)                 TDM 1116 ( ACTV )
        C   LEVEL    TIME LAST BACKUP     C   LEVEL    TIME LAST BACKUP
        - -------- ---------------------- - -------- ----------------------
FD BKUP Y       35 09-02-19 09:38:25 GMT  Y       35 09-02-19 09:38:25 GMT
FD CRNT Y      106                        Y      106
        MCAP 1113                         MCAP 1115
        - --------                        - --------
RD BKUP -    -         -        -         Y       35 09-02-19 09:27:17 GMT
USB BKP -    -         -        -         Y        3 09-02-07 01:11:22 GMT

    If the database is coherent, continue the procedure with 2.

    If the database is not coherent, refer to Verifying the Database and resolve the database problems. After the database problems have been resolved, continue the procedure with 2.

  2. Display the E5-IPSMs that are in the database by entering this command.

    rept-stat-card:appl=ips

    This is an example of the possible output. 

    
rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0
CARD   VERSION      TYPE      GPL        PST            SST        AST     
1111   131-010-000  IPSM      IPSHC      IS-NR          Active     -----     
1317   -----------  IPSM      IPS        OOS-MT         Isolated   -----     
2217   131-010-000  IPSM      IPS        IS-NR          Active     -----     

Command Completed.
    E5-IPSMs are shown by the entry IPSHC in the GPL column of the rept-stat-gpl output. IPSMs are shown by the entry IPS in the GPL column of the rept-stat-gpl output. Continue the procedure by performing one of these actions.
    • If no entries are shown in the rept-stat-card output, add an E5-IPSM by performing the procedure Adding an E5-IPSM. After the E5-IPSM has been added, continue the procedure with 3.
    • If E5-IPSMs are shown in the rept-stat-card output, continue the procedure with 3.
    • If only IPSMs are shown in the rept-stat-card output, continue the procedure by performing one of these actions.
      • If two or less entries are shown in this step, add the E5-IPSM by performing the procedure Adding an E5-IPSM After the E5-IPSM has been added, continue the procedure with 3.
      • If three entries are shown in this step, no more IPSMs or E5-IPSMs can be added. A IPSM must be removed so the E5-IPSM can be added. perform the procedure Removing an E5-IPSM to remove the IPSM. Add the E5-IPSM by performing the procedure Adding an E5-IPSM After the E5-IPSM has been added, continue the procedure with 3.
  3. Display the FTP servers that are provisioned in the database by entering the rtrv-ftp-serv command. This is an example of the possible output. 
    rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0

APP       IPADDR           LOGIN            PRIO  PATH
--------  ---------------  ---------------  ----  ----
db        10.20.50.102     dbuser1          1     ~/eagle
dist      100.200.50.102   dbuser1          1     ~/eagle
meas      1.255.0.100      ftpmeas3         3     ~meas\local

    If the entry db is shown in the APP column, continue the procedure with 4.

    If the entry db is not shown in the APP column, perform the procedure Adding an FTP Server to add the FTP server. After the FTP server has been added, continue the procedure with 4.

  4. Enter the chg-db:action=backup:dest=server command.

    During command execution, these messages should appear. 

    
BACKUP (SERVER): MASP A - Backup starts on active MASP.
BACKUP (SERVER) : Copy Database to card memory for processing.
BACKUP (SERVER) : Compress Database before archiving.
BACKUP (SERVER) : Send database archive to server.
BACKUP (SERVER): MASP A - Backup to remote server complete.

    A file with the following naming convention is created.

    “CLLI string”-“Release number string”-“yymmddhh”.tar.gz

    The CLLI string is the CLLI value shown in the output header. The release number string is the release number shown in the output header. If the archbldid option, shown in the rtrv-stpopts output, is set to yes, the release number string contains the build number instead of the release number. If you wish to change the archbldid option, perform the procedure Configuring the Archive Build ID Option. The string yymmddhh is the year (yy - 2 digits), the month (mm), the day (dd), and the hour (hh) that the backup was performed. For example, the file name for a backup performed on September 26, 2008 at 12 noon would be: rlghncxa03w-39.2.0-08092612.tar.gz. The file name for the backup can contain a maximum of 39 alphanumeric characters. This file name will be needed to restore the database from the FTP server. Record this filename.

Figure D-3 Making a Backup of the Database to the FTP Server



Sheet 1 of 2



Sheet 2 of 2

D.3 Restoring the Database from the FTP Server

This procedure is used to restore the database from the FTP server using the chg-db command with these parameters.

  • action=restore
  • src=server
  • file - the name of the TAR file on the FTP server that contains database that is being restored. The file parameter value is the file name that was created when the database was backed up to the FTP server. The file parameter value can contain a maximum of 39 alphanumeric characters. Refer to Making a Backup of the Database to the FTP Server for more information about the file name for database backups to the FTP server.

Note:

As of Release 46.5, the E5-IPSM card and its functionality is replaced by the E5-ENET-B (p/n 870-2971-01) or SLIC (p/n 7094646) card. Any references to E5-IPSM and the 870-2877-01 part number should be replaced by the 46.5 and greater card and part number.

The EAGLE must contain at least one E5-IPSM and an FTP server for the DB application. The rept-stat-card command with the appl=ips parameter displays the E5-IPSMs and IPSMs that are in the database. E5-IPSMs are shown by the entry IPSHC in the GPL column of the rept-stat-gpl output. IPSMs are shown by the entry IPS in the GPL column of the rept-stat-card output. The rtrv-ftp-serv command shows the FTP servers that are configured. E5-IPSMs can be added by performing the procedure Adding an E5-IPSM. FTP servers can be added by performing the procedure Adding an FTP Server.

The EAGLE must contain at least one E5-IPSM and an FTP server for the DB application. The rtrv-stp command with the gpl=ipshc parameter displays the E5-IPSMs. The rtrv-ftp-serv command shows the FTP servers that are configured. E5-IPSMs can be added by performing the procedure Adding an E5-IPSM. FTP servers can be added by performing the procedure Adding an FTP Server.

Caution:

Using the action=restore parameter with the chg-db command is an emergency recovery procedure, and requires the init-sys command to download the restored database to all the cards in the EAGLE.
  1. Display the E5-IPSMs that are in the database by entering this command.

    rept-stat-card:appl=ips

    This is an example of the possible output. 

    
rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0
CARD   VERSION      TYPE      GPL        PST            SST        AST     
1111   131-010-000  IPSM      IPSHC      IS-NR          Active     -----     
1317   -----------  IPSM      IPS        OOS-MT         Isolated   -----     
2217   131-010-000  IPSM      IPS        IS-NR          Active     -----     

Command Completed.
    E5-IPSMs are shown by the entry IPSHC in the GPL column of the rept-stat-card output. IPSMs are shown by the entry IPS in the GPL column of the rept-stat-card output. Continue the procedure by performing one of these actions.
    • If no entries are shown in the rept-stat-card output, add an E5-IPSM by performing the procedure Adding an E5-IPSM. After the E5-IPSM has been added, continue the procedure with 2.
    • If E5-IPSMs are shown in the rept-stat-card output, continue the procedure with 2.
    • If only IPSMs are shown in the rept-stat-card output, continue the procedure by performing one of these actions.
      • If two or less entries are shown in this step, add the E5-IPSM by performing the procedure Adding an E5-IPSM After the E5-IPSM has been added, continue the procedure with 2.
      • If three entries are shown in this step, no more IPSMs or E5-IPSMs can be added. An IPSM must be removed so the E5-IPSM can be added. perform the procedure Removing an E5-IPSM to remove the IPSM. Add the E5-IPSM by performing the procedure Adding an E5-IPSM After the E5-IPSM has been added, continue the procedure with 2.
  2. Display the FTP servers that are provisioned in the database by entering the rtrv-ftp-serv command. This is an example of the possible output. 
    rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0

APP       IPADDR           LOGIN            PRIO  PATH
--------  ---------------  ---------------  ----  ----
db        10.20.50.102     dbuser1          1     ~/eagle
dist      100.200.50.102   dbuser1          1     ~/eagle
meas      1.255.0.100      ftpmeas3         3     ~meas\local

    If the entry db is shown in the APP column, continue the procedure with 3.

    If the entry db is not shown in the APP column, perform the procedure Adding an FTP Server to add the FTP server. After the FTP server has been added, continue the procedure with 3.

  3. Enter the chg-db command with the action=restore, src=server, and file parameters. For this example, enter this command.

    chg-db:action=restore:src=server:file="rlghncxa03w-39.2.0-08092612.tar.gz"

    During command execution, these messages appear (the active MASP is displayed first). 

    
RESTORE (SERVER) : Retrieve database archive from server.
RESTORE (SERVER) : Validate database archive.
RESTORE (SERVER) : Restore starts on active MASP.
RESTORE (SERVER) : Restore from server on active MASP complete.
RESTORE (SERVER) : Restore starts on standby MASP.
RESTORE (SERVER) : Restore from server on standby MASP complete.
RESTORE (SERVER) : MASP(s) will reboot to load data.
  4. When the commands have successfully completed, re-initialize the EAGLE using the init-sys command.

    Note:

    The init-sys command causes a complete reload of the EAGLE, and should only be used during periods of low traffic. Using this command ensures that all cards are running the same database, but will interrupt service.

    Note:

    The init-sys command must be entered twice within 30 seconds for the EAGLE to be re-initialized. If the init-sys command is not executed twice within 30 seconds, the attempt to re-initialize the EAGLE is aborted.

    When the init-sys command is first entered, this message should appear. 

    
rlghncxa03w 08-09-01  07:05:01 GMT  EAGLE5 39.2.0
CAUTION: This command causes a complete system reload, and
will result in traffic loss.
Re-enter command within 30 seconds to confirm.

    When the init-sys command is re-entered within the 30 second time limit, this message should appear. 

    
rlghncxa03w 08-09-01  07:05:17 GMT  EAGLE5 39.2.0
Init System command issued at terminal #4

    From the time that the init-sys command is accepted, you must wait approximately 2 minutes before you can perform 5 (logging into the EAGLE). If the EAGLE terminal is in the VT-100/VT-320 mode, the terminal display will be refreshed with non-zero alarm counts. During this 2 minutes interval, an intermediate screen refresh caused by the MASPs role change from active to standby, and from standby to active. This screen refresh is typically a partial refresh and the alarm indicators are set to zero.

    If you are logged into the EAGLE in the KSR mode, the only response you will receive that you are now able to log into the EAGLE is that you will receive UAM 0009, MASP became active. UAM 0009 could be issued twice due to possible transient MASP role change (switching from active to standby). Following the execution of the init-sys command, the MASP that was active before the init-sys command was entered will be the active MASP when the EAGLE has finished reinitializing.

  5. Log into the EAGLE using the login or act-user command.

    This is an example of the messages that appear when you have successfully logged into the EAGLE. 

    
NOTICE: This is a private computer system. 
Unauthorized access or use may lead to prosecution. 

0 LOGIN failures since last successful LOGIN
Last successful LOGIN was on port 4 on 08-09-01 @ 05:34:56
  6. Verify that the databases on the removable cartridge (RD BKUP) and the current partitions of both MASPs (FD CRNT) are coherent using the rept-stat-db command.

    This is an example of the possible output. 

    
rlghncxa03w 08-09-01 16:07:48 GMT  EAGLE5 39.2.0
DATABASE STATUS: >> OK <<
        TDM 1114 ( STDBY)                 TDM 1116 ( ACTV )
         C  LEVEL     TIME LAST BACKUP     C  LEVEL     TIME LAST BACKUP
         - -------- ---------------------  - -------- ---------------------
FD BKUP  Y       35 08-09-01 07:06:18 GMT  Y       35 08-09-01 07:06:18 GMT
FD CRNT  Y      106                        Y      106
         MDAL 1117
         - --------
RD BKUP  -        -     -        -

    If E5-based control cards are installed in the EAGLE, this is an example of the output.

    
rlghncxa03w 09-03-01 16:07:48 GMT  EAGLE5 40.1.0
DATABASE STATUS: >> OK <<
        TDM 1114 ( STDBY)                 TDM 1116 ( ACTV )
        C   LEVEL    TIME LAST BACKUP     C   LEVEL    TIME LAST BACKUP
        - -------- ---------------------- - -------- ----------------------
FD BKUP Y       35 09-02-19 09:38:25 GMT  Y       35 09-02-19 09:38:25 GMT
FD CRNT Y      106                        Y      106
        MCAP 1113                         MCAP 1115
        - --------                        - --------
RD BKUP -    -         -        -         Y       35 09-02-19 09:27:17 GMT
USB BKP -    -         -        -         Y        3 09-02-07 01:11:22 GMT

Figure D-4 Restoring the Database from the FTP Server



D.4 Configuring the Archive Build ID Option

When the database is backed up to the FTP server, the release number string of the file name that is created is either the software release number or the software build number. The archbldid value of the on or off parameters of the chg-stpopts command determines which number is used as the release number string.

  • If the on=archbldid parameter is specified, the software build number is used as the release number string.
  • If the off=archbldid parameter is specified, the software release number is used as the release number string.

The system default value for the archbldid parameter is off .

  1. Display the value for the archbldid parameter by entering the rtrv-stpopts command.

    The value of the archbldid parameter is shown in the ARCHBLDID field. This is an example of the possible output. 

    
rlghncxa03w 10-07-17 16:02:05 GMT  EAGLE5 42.0.0
STP OPTIONS
-----------------------
ARCHBLDID          off

    Note:

    The rtrv-stpopts command output contains other fields that are not used by this procedure. If you wish to see all the fields displayed by the rtrv-stpopts command, see the rtrv-stpopts command description in Commands User's Guide.
  2. Change the value of the archbldid parameter.

    To change the archbldid parameter to on, enter this command.

    chg-stpopts:on=archbldid

    To change the archbldid parameter to off, enter this command.

    chg-stpopts:off=archbldid

    When this command has successfully completed, this message should appear. 

    
rlghncxa03w 06-10-07 00:22:57 GMT  EAGLE5 36.0.0
CHG-STPOPTS: MASP A - COMPLTD
  3. Verify the changes using the rtrv-stpopts command.

    If the on=archbldid parameter was specified in 2, this is an example of the possible output. 

    
rlghncxa03w 10-07-17 16:02:05 GMT  EAGLE5 42.0.0
STP OPTIONS
-----------------------
ARCHBLDID          on

    If the off=archbldid parameter was specified in 2, this is an example of the possible output. 

    
rlghncxa03w 10-07-17 16:02:05 GMT  EAGLE5 42.0.0
STP OPTIONS
-----------------------
ARCHBLDID          off

    Note:

    The rtrv-stpopts command output contains other fields that are not used by this procedure. If you wish to see all the fields displayed by the rtrv-stpopts command, see the rtrv-stpopts command description in Commands User's Guide.
  4. Back up the new changes using the chg-db:action=backup:dest=fixed command.

    These messages should appear, the active Maintenance and Administration Subsystem Processor (MASP) appears first. 

    
BACKUP (FIXED) : MASP A - Backup starts on active MASP.
BACKUP (FIXED) : MASP A - Backup on active MASP to fixed disk complete.
BACKUP (FIXED) : MASP A - Backup starts on standby MASP.
BACKUP (FIXED) : MASP A - Backup on standby MASP to fixed disk complete.

Figure D-5 Configuring the Archive Build ID Option