Router Installation and Configuration Manual/Backup/Restore Menu: Managing Configurations

From ImageStream Router Documentation

Jump to: navigation, search

Contents

Introduction

This chapter describes how to manage router configurations. ImageStream routers are equipped with flash storage for managing the user-defined configurations on the router. The router also provides other tools to allow for configuration backup and restoration on remote systems.
This chapter includes the following topics:
  • Backing up configurations to floppy disk
  • Backing up configurations to a remote machine using ftp
  • Backing up configurations to a remote machine using scp
  • Backing up configurations to the flash device
  • Backing up configurations to a file
  • Backing up configurations through a terminal program using ZMODEM
  • Restoring configurations from a floppy disk
  • Restoring configurations from a remote machine using ftp
  • Restoring configurations from a remote machine using scp
  • Restoring configurations from the flash device
  • Restoring configurations from a file
  • Restoring configurations through a terminal program using ZMODEM
The user-defined configuration backup procedure is configurable. The backup utility on the router uses a pre-defined file list to determine which files will be archived. You can archive additional configurations or programs that you have stored on your ImageStream router. The backup utility checks the /root/FileListing file available from the Bash shell. Any directory paths or files listed in this file will be archived.
Note: You should only change the /root/FileListing file if you are an advanced user. The default values in this file will back up all user-defined configurations automatically, and there is generally no need to change them.
After logging in, the main menu is displayed (your menu may look slightly different):
     ISis-Router main menu 
     1. Configuration menu 
     2. Show interface status 
     3. Advanced 
     4. Router software management 
     5. Backup/Restore 
     6. halt/reboot 
     0. Log off 
Select the "Backup/Restore" option by pressing 4 and Enter. The next menu should appear:
     Backup/Restore 
     1. Backup methods 
     2. Restore methods 
     0. ISis-Router main menu

Using the Backup Menu

Select the "Backup methods" option by pressing 1 and Enter. The "Backup methods" menu should appear:
     Backup methods 
     1. Backup configuration to floppy 
     2. Backup configuration to another machine via ftp 
     3. Backup configuration to another machine via scp 
     4. Backup configuration to flash 
     5. Backup configuration to file 
     6. Backup configuration to another machine via zmodem 
     0. Backup/Restore

Backing Up Configurations to a Floppy Disk

1. Backup configuration to floppy
To use this option, your router must be a model that is equipped with a "3.5" floppy drive. If your router does not have a floppy drive, you cannot use this backup option. To backup your configurations to a floppy disk, insert a floppy disk into the drive and select menu option 1 and press Enter. The floppy disk does not have to be formatted. The backup process will delete any preexisting data on the floppy disk. After selecting this option, the router will display the following message:
     Insert a floppy diskette then hit <Enter>. 
Press Enter once you have inserted the floppy disk. The router will then format the floppy disk and backup the running configuration from memory to the floppy disk:
     Formatting floppy diskette...done 
     Configuration saved to floppy 
The messages will only be displayed for a few seconds, and then you will be returned to the Backup methods menu.

Backing Up Configurations to a Remote Machine using FTP

2. Backup configuration to another machine via ftp
The router configurations can be backed up on a remote machine using the FTP service. To backup your configurations, select menu option 2 and press Enter. To use this option, you must have access to a remote machine with a functioning FTP server and user account. After selecting this option, the router will display the message:
     Enter destination to backup to "<user>@<hostname>:<directory>" : 
Enter the login name, hostname or IP address, and path where the configuration archive should be stored at this prompt. For example, if the remote FTP server is located at the IP address 192.168.100.10, your user account is support, and you want to store the configuration archive in the /tmp directory, you would enter:
     support@192.168.100.10:/tmp 
at the prompt. Press Enter once you have entered the remote server's login and path information. Once the router has connected to the remote FTP server, you will be prompted for a password.
The router will then copy a file named ISisConfig.tar.gz to the specified location on the FTP server. This file has been archived and compressed using the tar and gzip utilities, respectively. When the file has been copied successfully, a status message will be displayed for a few seconds (your message will look slightly different):
     /tmp/ISisConfig.tar.gz:	114.28 kB	2.75 MB/s
you will then be returned to the Backup methods menu.

Backing Up Configurations to a Remote Machine using SCP

3. Backup configuration to another machine via scp
The router configurations can be backed up on a remote machine using the scp (secure copy) service. To use this option, you must have access to a remote machine with a functioning SSH server and user account. To backup your configurations, select menu option 3 and press Enter. After selecting this option, the router will display the message:
     Enter destination to backup to "<user>@<hostname>:<directory>" : 
Enter the login name, hostname or IP address, and path where the configuration archive should be stored at this prompt. For example, if the remote FTP server is located at the IP address 192.168.100.10, your user account is support, and you want to store the configuration archive in the /tmp directory, you would enter:
     support@192.168.100.10:/tmp 
at the prompt. Press Enter once you have entered the remote server's login and path information. The router will temporarily save the configuration archive in the /tmp directory and then attempt to copy it to the remote server you specified. Once the router has connected to the remote machine, you will be prompted for a password.
The router will then copy a file named ISisConfig.tar.gz to the specified location on the remote machine. This file has been archived and compressed using the tar and gzip utilities, respectively. When the file has been copied successfully, a status message will be displayed for a few seconds (your message will look slightly different):
     ISisConfig.tar.gz	100% |***	***|	114 KB	00:00
     Configuration saved to 
     support@192.168.100.10:/tmp/ISisConfig.tar.gz 
you will then be returned to the Backup methods menu.

Backing Up Configurations to the Flash Device

4. Backup configuration to flash
To backup your configurations to the router's built-in flash storage device, select menu option 4 and press "Enter". The router will then backup the running configuration from memory to the flash device and display the following message:
     Configuration saved to flash 
The message will only be displayed for a few seconds, and then you will be returned to the Backup methods menu.

Backing Up Configurations to a File

5. Backup configuration to file
To backup your configurations to a file stored temporarily in the running memory, select menu option 5 and press Enter. Selecting this option will allow you to save your configurations to a file, which can be used to quickly restore a configuration or to copy to a remote machine. After selecting this option, the router will display the following message:
     Enter filename to backup configuration to : 
Enter the path to the location where you want to store the configuration archive. For example, it you want to store the configuration tar archive in the /tmp directory in a file called ISisConfig.tar.gz, you would enter:
     /tmp/ISisConfig.tar.gz 
at the prompt. Remember that the configuration archive created by the router is a gzipped tar archive, regardless of any file extensions you choose. By convention, ImageStream recommends using the .tar.gz extension on any configuration archive. Press Enter once you have entered the path information.
The router will then backup the running configuration from memory to the flash device and display the following message (your message may differ):
     Settings saved to /tmp/ISisConfig.tar.gz 
The message will only be displayed for a few seconds, and then you will be returned to the Backup methods menu.

Backing Up Configurations through a Terminal Program using ZMODEM

6. Backup configuration to another machine via zmodem
The router configurations can be backed up on a remote machine using the ZMODEM, XMODEM or YMODEM services. To use this option, your terminal program must support at least one of ZMODEM, XMODEM or YMODEM transfer services. Common programs such as minicom or HyperTerminal support ZMODEM transfers. Many popular SSH and telnet clients support ZMODEM transfers also. Refer to the documentation of your terminal program to determine if it supports this transfer function.
ImageStream recommends using the ZMODEM protocol whenever possible, since this protocol will transfer files the quickest. To backup your configurations, select menu option 6 and press Enter. After selecting this option, the router will display the following message:
     Enter filename to create and send to remote system : 
Enter the filename that you want to use for the configuration. Remember that the configuration archive created by the router is a gzipped tar archive, regardless of any file extensions you choose. By convention, ImageStream recommends using the .tar.gz extension on any configuration archive. For example, if you want to store the file router.tar.gz, you would enter:
     router.tar.gz 
at the prompt. Press Enter once you have entered the filename information. The router will temporarily save the configuration archive in the /tmp directory and then will display the message:
     Use X, Y or ZMODEM protocol (Default: ZMODEM)? (x/y/Z) 
Select the file transfer protocol that you want to use and that is supported by your terminal program. If you are unsure, select the default, ZMODEM, by pressing Z and Enter. The router will pause to allow you to set up your terminal program, if necessary (in most cases, terminal programs require no advance setup to receive files using ZMODEM). When you are ready to copy the file to the remote machine, press Enter.
The router will then copy a file using the name you specified in the first step to your local machine. Your terminal program may prompt you for a location to save this file, or the program may save the file automatically. Please refer to the documentation of your terminal program to determine where the backup archive will be stored. When the file has been copied successfully, you will be returned to the Backup methods menu.

Returning to the Backup/Restore Menu

0. Backup/Restore
Selecting this menu option returns you to the "Backup/Restore" menu. To return to the Backup/Restore menu, press 0 and Enter. The router will display the Backup/Restore menu:
     Backup/Restore 
     1. Backup methods 
     2. Restore methods 
     0. ISis-Router main menu

Using the Restore Menu

Select the "Restore methods" option by pressing 2 and Enter. ImageStream router configurations are portable between router models. You can restore configurations from any ImageStream router onto any other ImageStream router. After selecting the "Restore methods" option, the "Restore methods" menu should appear:
     Restore methods 
     1. Restore configuration from floppy 
     2. Restore configuration from another machine via ftp 
     3. Restore configuration from another machine via scp 
     4. Restore configuration from flash 
     5. Restore configuration from file 
     6. Restore configuration from another machine via zmodem 
     7. Restore router to factory defaults 
     0. Backup/Restore 

Restoring Configurations from a Floppy Disk

1. Restore configuration from floppy
To use this option, your router must be a model that is equipped with a "3.5" floppy drive. If your router does not have a floppy drive, you cannot use this restore option. To restore your configurations from a floppy disk, insert a floppy disk with a configuration saved from an ImageStream router into the drive and select menu option 1 and press Enter. The floppy disk must be one created by a backup floppy command (or menu option) on an ImageStream router. If a floppy disk without a valid configuration archive is inserted, the router will display the following message:
     Error: Not a backup configuration. Please insert proper floppy. 
Once you have inserted a valid floppy disk, the router will copy the configuration from the floppy disk to the running configuration in memory and display the following message:
     Configuration restored from floppy 
The message will be displayed for a few seconds, and you will be returned to the Restore methods menu. You must backup your configurations to flash after using this method. The restoration process only affects the running configuration not the one stored in the router's nonvolatile flash device.


Restoring Configurations from a Remote Machine using FTP

2. Restore configuration from another machine via ftp
The router configurations can be restored from an archive stored on a remote machine by using the FTP service. To restore your configurations via FTP, select menu option 2 and press Enter. To use this option, you must have access to a stored configuration on a remote machine with a functioning FTP server and user account. After selecting this option, the router will display the following message:
     Enter where to restore backup from 
     "<user>@<hostname>:<directory>" : 
Enter the login name, hostname or IP address, and path where the configuration archive named ISisConfig.tar.gz is located at this prompt. For example, if the remote FTP server is located at the IP address 192.168.100.10, your user account is support, and you want to restore the configuration archive from the /tmp directory, you would enter:
     support@192.168.100.10:/tmp 
at the prompt. Press Enter once you have entered the remote server's login and path information. Once the router has connected to the remote FTP server, you will be prompted for a password. When the file has been copied successfully, the router will copy the configuration from the configuration archive to the running configuration in memory. The router will display a status message (your message will look slightly different):
     /tmp/ISisConfig.tar.gz:	114.28 kB	2.75 MB/s
The message will be displayed for only a few seconds, and then you will be returned to the "Restore methods" menu. You must backup your configurations to flash after using this method. The restoration process only affects the running configuration, and not the one stored in the router's nonvolatile flash device.

Restoring Configurations from a Remote Machine using SCP

3. Restore configuration from another machine via scp
The router configurations can be restored from an archive stored on a remote machine by using the scp (secure copy) service. To restore your configurations via scp, select menu option 3 and press Enter. To use this option, you must have access to a stored configuration on a remote machine with a functioning SSH server and user account. After selecting this option, the router will display the following message:
     Enter where to restore backup from "<user>@<hostname>:<directory>" : 
enter the login name, hostname or IP address, and path where the configuration archive named ISisConfig.tar.gz is located at this prompt. For example, if the remote server is located at the IP address 192.168.100.10, your user account is support, and you want to restore the configuration archive from the /tmp directory, you would enter:
     support@192.168.100.10:/tmp 
at the prompt. Press Enter once you have entered the remote server's login and path information. Once the router has connected to the remote server, you will be prompted for a password. When the file has been copied successfully, the router will copy the configuration from the configuration archive to the running configuration in memory. The router will display a status message (your message will look slightly different):
     ISisConfig.tar.gz	100% |***	***|	114 KB	00:00
     Configuration restored from support@192.168.100.10:/tmp 
The message will be displayed for only a few seconds, and then you will be returned to the "Restore methods" menu. You must backup your configurations to flash after using this method. The restoration process only affects the running configuration, and not the one stored in the router's nonvolatile flash device.

Restore Configurations from the Flash Device

4. Restore configuration from flash
To restore your configurations from the router's built-in flash storage device, select menu option 4 and press Enter. The router will then copy the stored configuration from the flash device to the running configuration in memory and then display the following message:
     Configuration restored from flash 
The message will only be displayed for a few seconds, and then you will be returned to the Restore methods menu.

Restore Configurations from a File

5. Restore configuration from a file
To restore your configurations from a file stored temporarily in the running memory, select menu option 5 and press Enter. Selecting this option will allow you to restore your configurations from a file. After selecting this option, the router will display the following message:
     Enter filename to restore configuration from : 
enter the path to the location where you want to store the configuration archive. For example, it you want to store the configuration tar archive in the /tmp directory in a file called ISisConfig.tar.gz, you would enter:
     /tmp/ISisConfig.tar.gz 
at the prompt. Remember that the configuration archive created by the router is a gzipped tar archive, regardless of any file extensions you choose. By convention, ImageStream recommends using the .tar.gz extension on any configuration archive. Press Enter once you have entered the path information. The router will then restore the running configuration using the configuration archive you specified and display the message (your message may differ):
     Settings restored from /tmp/ISisConfig.tar.gz 
The message will only be displayed for a few seconds, and then you will be returned to the Restore methods menu.

Backing Up Configurations through a Terminal Program using ZMODEM

6. Restore configuration from another machine via zmodem
The router configurations can be restored from a remote machine using the ZMODEM, XMODEM or YMODEM services. To use this option, your terminal program must support at least one of ZMODEM, XMODEM or YMODEM transfer services. Common programs such as minicom or HyperTerminal support ZMODEM transfers. Many popular SSH and telnet clients support ZMODEM transfers also. Refer to the documentation of your terminal program to determine if it supports this transfer function.
ImageStream recommends using the ZMODEM protocol whenever possible, since this protocol will transfer files the quickest. To restore your configurations, select this menu option 6 and press Enter. After selecting this option, the router will display the following message:
     Use X, Y or ZMODEM protocol (Default: ZMODEM)? (x/y/Z) 
Select the file transfer protocol that you want to use and that is supported by your terminal program. If you are unsure, select the default, ZMODEM, by pressing Z and Enter. The router will pause to allow you to set up your terminal program, if necessary (in most cases, terminal programs require no advance setup to receive files using ZMODEM). When you are ready to copy the file from the remote machine, press Enter.
The router will then restore the running configuration using the configuration archive you specified and display the message (your message may differ):
     Configuration restored from ISisConfig.tar.gz 
The message will only be displayed for a few seconds, and then you will be returned to the Restore methods menu.

Restore Router to Factory Defaults

7. Restore router to factory defaults
To restore your router's flash device to its factory default settings, select this menu option 7 and press Enter. Selecting this option will clear all user-defined configurations from the flash device on the router. This option does not affect the running configuration. After selecting this option, the router will display a menu:
     Restore router to factory defaults 
     1. Yes 
     0. No 
Press 1 and Enter to confirm that you want to restore the router to factory defaults. The router will display the following message:
     1+0 records in 
     1+0 records out 
     Router restored to factory defaults 
     Press enter/return to quit 
Press Enter to return to the menu. Press 0 and Enter to return to the Restore methods menu:
     Restore methods 
     1. Restore configuration from floppy 
     2. Restore configuration from another machine via ftp 
     3. Restore configuration from another machine via scp 
     4. Restore configuration from flash 
     5. Restore configuration from file 
     6. Restore configuration from another machine via zmodem 
     7. Restore router to factory defaults 
     0. Backup/Restore

Returning to the Backup/Restore Menu

0. Backup/Restore

Selecting this menu option returns you to the "Backup/Restore" menu. To return to the "Backup/Restore menu"", press 0 on the keyboard and press Enter. The router will display the Backup/Restore menu:

     Backup/Restore 
     1. Backup methods 
     2. Restore methods 
     0. ISis-Router main menu
Personal tools
Router software releases