01-Fundamentals Configuration Guide

HomeSupportSwitchesH3C S5130 Switch SeriesConfigure & DeployConfiguration GuidesH3C S5130-HI Configuration Guides-R1118P02[R1122]-6W10201-Fundamentals Configuration Guide
06-Configuration file management configuration
Title Size Download
06-Configuration file management configuration 126.42 KB

Managing configuration files

Overview

You can manage configuration files from the CLI or the Boot ROM menu. The following information explains how to manage configuration files from the CLI.

A configuration file saves a set of commands for configuring software features on the device. You can save any configuration to a configuration file so the configuration can survive a reboot. You can also back up configuration files to a host for future use.

Configuration types

The configuration loaded at startup is called startup configuration and the configuration that is running on the device is called running configuration.

Startup configuration

The device uses startup configuration to configure software features during startup.

The following are sources of startup configuration:

·     Initial settingsInitial values or states for parameters. If the device starts up with empty configuration, all parameters use their initial settings at startup.

No commands are available to display the initial settings. For more information about these settings, see the Default sections in the command references.

·     Factory defaultsProduct-specific default settings that are different from initial settings. The factory defaults are included in the .ipe software image file. If you do not configure the device to start up with the initial settings or a startup configuration file, the device loads the factory defaults to configure features at startup. If a parameter is not included in the factory defaults, the device uses its initial settings.

To display the factory defaults, use the display default-configuration command.

·     Startup configuration file—Configuration file you specify in the Boot ROM menu or CLI for startup. The file is called the next-startup configuration file. After the file is loaded at startup, it is also called the current startup configuration file. For high availability, you can specify two next-startup configuration files, one main and one backup (see "Specifying a next-startup configuration file").

To display the names of the current startup configuration file and the next-startup configuration files, use the display startup command.

To display the next-startup configuration contents, use the display saved-configuration command. This command does not display settings that have not been saved to the configuration file.

Running configuration

The running configuration includes unchanged startup settings and new settings. The running configuration is stored in memory and is cleared at a device reboot or power off. To use the running configuration after a power cycling or reboot, save it to a configuration file.

To display the running configuration, use the display current-configuration command. The displayed configuration does not include parameters that use initial settings.

Startup configuration loading process

Figure 1 shows the configuration loading process during startup.

Figure 1 Configuration loading process during startup

 

The device uses the following process to select the configuration to load at startup:

1.     If you access the Boot ROM menu to select the Skip Current System Configuration option, the device starts up with empty configuration. All parameters use their initial settings.

2.     If you do not start the device with empty configuration, the following process applies:

a.     If you have specified a main startup configuration file, and this configuration file is available, the device starts up with this startup configuration file.

b.     If you have not specified a main startup configuration file, or the specified main startup configuration file is not available, the device searches for the backup startup configuration file.

c.     If you have not specified a backup startup configuration file, or the specified file is not available, the device starts up with the factory defaults. If a parameter is not included in the factory defaults, its initial setting is used.

Configuration file formats

Configuration files you specify for saving configuration must use the .cfg extension. A .cfg configuration file is a human-readable text file. When you save configuration to a .cfg file, the device automatically saves the configuration to an .mdb user-inaccessible binary file that has the same name as the .cfg file. The device loads an .mdb file faster than loading a .cfg file.

Startup configuration file selection

At startup, the device uses the following procedure to identify the configuration file to load:

1.     The device searches for a valid .cfg next-startup configuration file.

2.     If one is found, the device searches for an .mdb file that has the same name and content as the .cfg file.

3.     If a matching .mdb file is found, the device starts up with the .mdb file. If none is found, the device starts up with the .cfg file.

Unless otherwise stated, the term "configuration file" in this document refers to a .cfg configuration file.

Configuration file content organization and format

IMPORTANT

IMPORTANT:

To run on the device, a configuration file must meet the content and format requirements. To ensure a successful configuration load at startup, use a configuration file that was automatically created on the device or created by using the save command. If you edit the configuration file, make sure all edits are compliant with the requirements.

 

A configuration file must meet the following requirements:

·     All commands are saved in their complete form.

·     Commands are sorted into sections by different command views, including system view, interface views, protocol views, and user line views.

·     Two adjacent sections are separated by a comment line that starts with a pound sign (#).

·     The configuration file ends with the word return.

The following is a sample configuration file excerpt:

#

local-user root class manage

 password hash $h$6$Twd73mLrN8O2vvD5$Cz1vgdpR4KoTiRQNE9pg33gU14Br2p1VguczLSVyJLO2huV5Syx/LfDIf8ROLtVErJ/C31oq2rFtmNuyZf4STw==

 service-type ssh telnet terminal

 authorization-attribute user-role network-admin

 authorization-attribute user-role network-operator

#

interface GigabitEthernet1/0/1

 port link-mode route

 ip address 1.1.1.1 255.255.255.0

#

FIPS compliance

The device supports the FIPS mode that complies with NIST FIPS 140-2 requirements. Support for features, commands, and parameters might differ in FIPS mode and non-FIPS mode. For more information about FIPS mode, see Security Configuration Guide.

Enabling configuration encryption

Configuration encryption enables the device to encrypt a startup configuration file automatically when it saves the running configuration. All H3C devices running Comware 7 software use the same private key or public key to encrypt configuration files.

 

 

NOTE:

Any H3C devices running Comware 7 software can decrypt the encrypted configuration files. To prevent an encrypted file from being decoded by unauthorized users, make sure the file is accessible only to authorized users.

 

To enable configuration encryption:

 

Step

Command

Remarks

1.     Enter system view.

system-view

N/A

2.     Enable configuration encryption.

configuration encrypt { private-key | public-key }

By default, configuration encryption is disabled. Configuration is saved unencrypted.

 

Comparing configurations for their differences

You can compare configuration files or compare a configuration file with the running configuration for their differences.

If you specify the next-startup configuration for a comparison, the system selects the next-startup configuration file to be compared with in the following order:

1.     The main next-startup configuration file.

2.     The backup next-startup configuration file if the main next-startup configuration file is unavailable, for example, the configuration file does not exist or is corrupt.

If both the main and backup next-startup configuration files are unavailable, the system displays a message indicating that no next-startup configuration files exist.

To compare configurations for their differences in any view:

 

Task

Command

Display the differences that a configuration file, the running configuration, or the next-startup configuration has as compared with the specified source configuration file.

display diff configfile file-name-s { configfile file-name-d | current-configuration | startup-configuration }

Display the differences that a configuration file or the next-startup configuration has as compared with the running configuration.

display diff current-configuration { configfile file-name-d | startup-configuration }

Display the differences that a configuration file has as compared with the next-startup configuration.

display diff startup-configuration configfile file-name-d

Display the differences that the running configuration has as compared with the next-startup configuration.

·     Method 1:
display diff startup-configuration current-configuration

·     Method 2:
display current-configuration diff

 

Saving the running configuration

Restrictions and guidelines

When an IRF member device splits from the IRF fabric, its settings are retained in memory but removed from the running configuration on the IRF fabric. Saving the running configuration before the IRF fabric recovers will remove the member device's settings from the next-startup configuration file.

If you have saved the running configuration before the member device rejoins the IRF fabric, perform the following steps to restore the member device settings to the next-startup configuration file:

1.     Resolve the split issue.

2.     Reboot the member device to rejoin the IRF fabric.

3.     After the member device rejoins the IRF fabric, execute the display current-configuration command to verify that the member device's settings have been restored from memory to the running configuration.

4.     Save the running configuration to the next-startup configuration file on the IRF fabric.

 

IMPORTANT

IMPORTANT:

To ensure a successful configuration restoration, make sure the IRF fabric has not rebooted after the member device left.

 

Using different methods to save the running configuration

When you save the running configuration to a configuration file, you can specify the file as a next-startup configuration file.

If you are specifying a file as a next-startup configuration file, use one of the following methods for saving the configuration:

·     Fast mode—Use the save command without the safely keyword. In this mode, the device directly overwrites the target next-startup configuration file. If a reboot or power failure occurs during this process, the next-startup configuration file is lost. You must specify a new startup configuration file after the device reboots (see "Specifying a next-startup configuration file").

·     Safe mode—Use the save command with the safely keyword. Safe mode is slower than fast mode, but more secure. In safe mode, the system saves the configuration in a temporary file and starts overwriting the target next-startup configuration file after the save operation is complete. If a reboot or power failure occurs during the save operation, the next-startup configuration file is still retained.

Use the safe mode if the power source is not reliable or you are remotely configuring the device.

To save the running configuration, perform of the following tasks in any view:

 

Task

Command

Remarks

Save the running configuration to a configuration file without specifying the file as a next-startup configuration file.

save file-url [ all | slot slot-number ]

N/A

Save the running configuration to a configuration file and specify the file as a next-startup configuration file.

save [ safely ] [ backup | main ] [ force ]

Make sure you save the configuration to a file in the root directory of the flash memory.

This command saves the configuration to all IRF member devices.

As a best practice, specify the safely keyword for reliable configuration saving.

If you specify only the safely keyword, the command saves the configuration to the main startup configuration file.

If the force keyword is specified, the command saves the configuration to the existing next-startup configuration file.

If the force keyword is not specified, the command allows you to specify a new next-startup configuration file.

 

Configuring configuration rollback

To replace the running configuration with the configuration in a configuration file without rebooting the device, use the configuration rollback feature. This feature helps you revert to a previous configuration state or adapt the running configuration to different network environments.

The configuration rollback feature compares the running configuration against the specified replacement configuration file and handles configuration differences as follows:

·     If a command in the running configuration is not in the replacement file, the rollback feature executes the undo form of the command.

·     If a command in the replacement file is not in the running configuration, the rollback feature adds the command to the running configuration.

·     If a command has different settings in the running configuration and the configuration file, the rollback feature replaces the running command setting with the setting in the configuration file.

To facilitate configuration rollback, the configuration archive feature was developed. This feature enables the system to save the running configuration automatically at regular intervals.

Configuration task list

Tasks at a glance

(Required.) Configuring configuration archive parameters

(Required.) Perform one of the following tasks:

·     Enabling automatic configuration archiving

·     Manually archiving the running configuration

(Required.) Rolling back configuration

 

Configuring configuration archive parameters

Before archiving the running configuration, either manually or automatically, you must configure a file directory and file name prefix for configuration archives.

Configuration archives are named in the format of prefix_serial number.cfg, for example, 20080620archive_1.cfg and 20080620archive_2.cfg. The serial number is automatically assigned from 1 to 1000, increasing by 1. After the serial number reaches 1000, it restarts from 1.

If you change the file directory or file name prefix, or reboot the device, the following events occur:

·     The old configuration archives change to common configuration files.

·     The configuration archive counter is reset.

·     The display archive configuration command no longer displays the old configuration archives.

·     The serial number for new configuration archives starts at 1.

After the maximum number of configuration archives is reached, the system deletes the oldest archive to make room for the new archive.

Configuration guidelines

In an IRF fabric, the configuration archive feature saves the running configuration only on the master device. To make sure the system can archive the running configuration after a master/subordinate switchover, create the directory on all IRF members.

Configuration procedure

To configure configuration archive parameters:

 

Step

Command

Remarks

1.     Enter system view.

system-view

N/A

2.     Configure the directory and file name prefix for archiving the running configuration.

archive configuration location directory filename-prefix filename-prefix

Do not include member ID information in the directory name.

By default, no path or file name prefix is set for configuration archives, and the system does not regularly save configuration.

IMPORTANT IMPORTANT:

The undo form of this command performs the following operations:

·     Disables both manual and automatic configuration archiving.

·     Restores the default settings for the archive configuration interval and archive configuration max commands.

·     Clears the archive configuration information displayed by using the display archive configuration command.

3.     (Optional.) Set the maximum number of configuration archives.

archive configuration max file-number

The default number is 5.

Change the setting depending on the amount of storage available on the device.

 

Enabling automatic configuration archiving

Make sure you have set an archive path and file name prefix before performing this task.

To enable automatic configuration archiving:

 

Step

Command

Remarks

1.     Enter system view.

system-view

N/A

2.     Enable automatic configuration archiving and set the archiving interval.

archive configuration interval minutes

By default, this feature is disabled.

To display configuration archive names and their archiving time, use the display archive configuration command.

 

Manually archiving the running configuration

To save system resources, disable automatic configuration archiving and manually archive the configuration if the configuration will not be changed very often. You can also manually archive configuration before performing complicated configuration tasks. Then, you can use the archive for configuration recovery if the configuration attempt fails.

Make sure you have set an archive path and file name prefix before performing this task.

Perform the following task in user view:

 

Task

Command

Manually archive the running configuration.

archive configuration

 

Rolling back configuration

To ensure a successful rollback, follow these restrictions and guidelines:

·     Do not remove or install a card while the system is executing the configuration replace file command.

·     Use the following types of configuration files to roll back configuration:

¡     Configuration file that was created on the local device by using the archive feature or the save command.

¡     Configuration file that was created on another device and transferred to the local device.

Make sure the command lines in the configuration file are fully compatible with the local device.

·     Make sure the replacement configuration file only contains hardware-consistency settings. For example, if the replacement configuration file contains the configuration for a card that has been removed, the system fails to roll the removed card's settings back.

·     The replacement configuration file is not encrypted.

To perform a configuration rollback:

 

Step

Command

Remarks

1.     Enter system view.

system-view

N/A

2.     Roll the running configuration back to the configuration defined by a configuration file.

configuration replace file filename

The specified configuration file must not be encrypted.

 

The configuration rollback feature might fail to reconfigure some commands in the running configuration for one of the following reasons:

·     A command cannot be undone because prefixing the undo keyword to the command does not result in a valid undo command. For example, if the undo form designed for the A [B] C command is undo A C, the configuration rollback feature cannot undo the A B C command. This is because the system does not recognize the undo A B C command.

·     A command (for example, a hardware-dependent command) cannot be deleted, overwritten, or undone due to system restrictions.

·     The commands in different views are dependent on each other.

·     Commands or command settings that the device does not support cannot be added to the running configuration.

·     The rollback operation does not take effect on the IRF settings. The IRF settings in the current running configuration continue to run after the rollback. For more information about IRF, see IRF Configuration Guide.

Configuring configuration commit delay

This feature enables the system to automatically remove the settings you made during a configuration commit delay interval if you have not manually committed them.

You specify the configuration commit delay interval by using the configuration commit delay timer. Any settings made during the delay interval will be automatically removed if you have not manually committed them before the timer expires.

This feature prevents a misconfiguration from causing the inability to access the device and is especially useful when you configure the device remotely.

When you use this feature, follow these restrictions and guidelines:

·     In a multi-user context, make sure no one else is configuring the device.

·     You cannot perform any operations during the configuration rollback.

·     The configuration commit delay feature is a one-time setting. The feature is disabled when the commit delay timer expires or after a manual commit is performed.

·     You can reconfigure the configuration commit delay timer before it expires to shorten or extend the commit delay interval. The settings made during the delay interval will be removed if you have not committed them before the new timer expires.

To configure the configuration commit delay feature:

 

Step

Command

1.     Enter system view.

system-view

2.     Start the commit delay timer.

configuration commit delay delay-time

3.     (Optional.) Commit the settings configured after the commit delay timer started.

configuration commit

 

Specifying a next-startup configuration file

CAUTION

CAUTION:

In an IRF fabric, using the undo startup saved-configuration command can cause an IRF split after the IRF fabric or an IRF member reboots.

 

You can specify a .cfg file as a next-startup configuration file when you execute the save [ safely ] [ backup | main ] [ force ] command.

Alternatively, you can use the startup saved-configuration cfgfile [ backup | main ] command to specify a .cfg configuration file as the main or backup next-startup configuration file. Make sure the specified configuration file is valid and has been saved to the root directory of the flash memory on each member device.

To specify a next-startup configuration file, perform the following task in user view:

 

Task

Command

Remarks

Specify a next-startup configuration file.

startup saved-configuration cfgfile [ backup | main ]

By default, no next-startup configuration files are specified.

Use the display startup command and the display saved-configuration command in any view to verify the configuration.

If you do not specify the backup or main keyword, this command specifies the configuration file as the main next-startup configuration file.

As a best practice, specify different files as the main and backup next-startup configuration files.

The undo startup saved-configuration command changes the attribute of the main or backup next-startup configuration file to NULL instead of deleting the file.

 

Backing up the main next-startup configuration file to a TFTP server

Before performing this task, make sure the following requirements are met:

·     The server is reachable.

·     The server is enabled with TFTP service.

·     You have read and write permissions to the server.

To back up the main next-startup configuration file to a TFTP server:

 

Step

Command

Remarks

1.     (Optional.) Verify that a next-startup configuration file has been specified in user view.

display startup

If no next-startup configuration file has been specified or the specified configuration file does not exist, the backup operation will fail.

2.     Back up the next-startup configuration file to a TFTP server in user view.

backup startup-configuration to dest-addr [ dest-filename ]

This command is not supported in FIPS mode.

 

Restoring the main next-startup configuration file from a TFTP server

Perform this task to download a configuration file to the device from a TFTP server and specify the file as the main next-startup configuration file.

Before restoring the main next-startup configuration file, make sure the following requirements are met:

·     The server is reachable.

·     The server is enabled with TFTP service.

·     You have read and write permissions to the server.

To restore the main next-startup configuration file from a TFTP server:

 

Step

Command

Remarks

1.     Restore the main next-startup configuration file from a TFTP server in user view.

restore startup-configuration from src-addr src-filename

This command is not supported in FIPS mode.

2.     (Optional.) Verify that the specified configuration file has been set as the main next-startup configuration file.

display startup

display saved-configuration

N/A

 

Deleting a next-startup configuration file

CAUTION

CAUTION:

This task permanently deletes a next-startup configuration file from all member devices. Before performing this task, back up the file as needed.

 

You can perform this task to delete a next-startup configuration file.

If both the main and backup next-startup configuration files are deleted, the device uses the factory defaults at the next startup.

To delete a file that is set as both main and backup next-startup configuration files, you must execute both the reset saved-configuration backup command and the reset saved-configuration main command. Using only one of the commands removes the specified file attribute instead of deleting the file.

For example, if the reset saved-configuration backup command is executed, the backup next-startup configuration file setting is set to NULL. However, the file is still used as the main file. To delete the file, you must also execute the reset saved-configuration main command.

Perform the following task in user view:

 

Task

Command

Remarks

Delete a next-startup configuration file.

reset saved-configuration [ backup | main ]

If you do not specify the backup or main keyword, this command deletes the main next-startup configuration file.

 

Displaying and maintaining configuration files

Execute display commands in any view.

 

Task

Command

Display configuration archive information.

display archive configuration

Display the running configuration.

display current-configuration [ configuration [ module-name ] | interface [ interface-type [ interface-number ] ] ]

Display the differences that the running configuration has as compared with the next-startup configuration.

display current-configuration diff

Display the factory defaults.

display default-configuration

Display the differences between configurations.

·     display diff configfile file-name-s { configfile file-name-d | current-configuration | startup-configuration }

·     display diff current-configuration { configfile file-name-d | startup-configuration }

·     display diff startup-configuration { configfile file-name-d | current-configuration }

Display the contents of the configuration file for the next system startup.

display saved-configuration

Display the names of the configuration files for this startup and the next startup.

display startup

Display the valid configuration in the current view.

display this

 

  • Cloud & AI
  • InterConnect
  • Intelligent Computing
  • Intelligent Storage
  • Security
  • SMB Products
  • Intelligent Terminal Products
  • Product Support Services
  • Technical Service Solutions
All Services
  • Resource Center
  • Policy
  • Online Help
  • Technical Blogs
All Support
  • Become A Partner
  • Partner Policy & Program
  • Global Learning
  • Partner Sales Resources
  • Partner Business Management
  • Service Business
All Partners
  • Profile
  • News & Events
  • Online Exhibition Center
  • Contact Us
All About Us
新华三官网