Configuration File Types

There are two types of configuration files on the GigaVUE H Series node—standard configuration files and text configuration files (known as command files):

■

Standard configuration files can be used to store and apply a set of settings with the configuration switch-to command.

■

Text configuration files are not really configuration files at all—instead, they are lists of CLI commands used to build a particular configuration. Text configuration files are useful both for both troubleshooting and backup purposes—you can quickly see the commands that built a particular configuration, or you can store regular backups of text files containing the commands on an external host. Text configuration files can also be applied in the CLI using the configuration text file <filename> apply command.

You work with text configuration files using the configuration text command and its arguments.

Information Excluded from Text Configuration Files

For security reasons, text configuration files do not include plaintext passwords, such as SMTP passwords, AAA keys (RADIUS or TACACS+), private keys in RSA/DSA identities. Because of this, they cannot completely restore a given configuration using configuration text file <filename> apply.

Reserved Empty Database File

The empty database file, empty_db_file_dnu, is a reserved file. Do not use (dnu) this filename in any database operation such as configuration write to or configuration switch-to commands as the filename is removed when the node is reloaded.

The configuration command has the following syntax:

configuration
   audit max-changes <number>
   copy <source leader in a bidirectional clock relationship (formerly master) filename | initial> <destination filename>
   delete <filename | initial>
   delete-all
   fetch <download URL> <filename>   jump-start
   move <source filename | initial> <destination filename>
   new <filename> [factory [keep-basic] [keep-connect]]
   revert saved   switch-to <filename | initial>
   text
      fetch <download URL>
         apply [discard] [fail-continue] [filename <filename>] [overwrite] [verbose]
         filename <filename> [apply] [fail-continue] [overwrite] [verbose]
         overwrite [apply] [fail-continue] [filename <filename>] [verbose]
      file <filename>
         apply [fail-continue] [verbose]
         delete
         rename <filename>
         upload <upload URL>
      generate
         active running <only-traffic> <save <filename>> | <upload <upload URL>>
         active saved <only-traffic> <save <filename>> | <upload <upload URL>>
         file <filename | initial> <save <filename>> | <upload <upload URL>>
   upload <initial | active> <upload URL>   write [local | to <filename>] [no-switch]

The following table describes the arguments for the configuration command:

Argument

Description

audit max-changes <number>

Sets the maximum number of configuration changes that will be logged for the audit feature.

copy <source filename | initial> <destination filename>

Makes a copy of the specified configuration file. Specify filenames for both the source and destination filenames. For example, the following command copies the configuration file named gigavue to a new file named mybackup:

(config) # configuration copy gigavue mybackup

Note that you cannot copy over the active configuration file. However, you can copy it to a new file—if you do so, the original remains active.

delete <filename | initial>

Deletes the named configuration file. You cannot delete the active configuration file.

Tip: Type a space and question mark after the delete argument to see the list of configuration files available for deletion.

For example:

(config) # configuration del ?

fetch <download URL> <filename>

Retrieves a saved configuration file from a remote host. Use HTTP(S), FTP, TFTP, or SCP to retrieve the file. The format for the download URL is as follows:

[protocol]://username[:password]@hostname/path/filename

For example, the following command retrieves the configuration file named myconfig from the FTP server at 192.168.1.10 using the robh account with the xray password:

(config) # configuration fetch ftp://robh:xray@192.168.1.10/myconfig

You can also use the <filename> argument to give the retrieved file a new name on the GigaVUE H Series node. For example, the following command retrieves myconfig and names it newconfig on the node:

(config) # configuration fetch scp://bbochy:catch1@192.168.1.75/myconfig newconfig

Note: You cannot retrieve a file with the same name as the currently active configuration file.

jump-start

Runs the configuration wizard for the initial setup of GigaVUE nodes. Refer to the Hardware Installation Guide for details.

Starting in software version 4.7, the configuration jump-start automatically starts and forces a password change. The system administrator must change the password on the default admin account.

move <source filename | initial> <destination filename>

Renames the specified configuration file. For example, the following command renames myconfig as newconfig:

(config) # configuration move myconfig newconfig

Note: The currently active configuration file cannot be either the source or destination of a move.

new <filename> [factory [keep-basic] [keep-connect]]

Creates a new configuration file with the specified filename. The parameters specify what configuration, if any, is carried forward from the current running configuration, as follows:

●

keep-basic—Preserves licenses, SSH host keys, and CMC rendezvous configuration.

●

keep-connect—Preserves anything necessary to maintain network connectivity to the system, such as interfaces, routes, and ARP.

You can select one or both or neither after factory. If no optional parameters are specified, the default is keep-basic.

revert saved

Reverts the system configuration to a previously saved state, either from the last saved configuration file or from the factory settings. Use the saved argument to revert the running configuration to the settings in the last saved configuration file.

For example:

(config) # configuration revert saved

switch-to <filename | initial>

Loads the named configuration file, making it the active file.

For example, the following command loads the myconfig configuration file:

(config) # configuration switch-to myconfig

text
   fetch <download URL>
      apply [discard] [fail-continue]
         [filename <filename>] [overwrite]
         [verbose]
      filename <filename> [apply]          [fail-continue] [overwrite] [verbose]
      overwrite [apply] [fail-continue]
         [filename <filename>] [verbose]

Retrieves a saved text configuration file from a remote host. Use HTTP(S), FTP, TFTP, or SCP to retrieve the file. The format for the download URL is as follows:

[protocol]://username[:password]@hostname/path/filename

For example, the following command retrieves the text configuration file named textconfig from the FTP server at 192.168.1.40 using the sven account with the svenpass password:

(config) # configuration text fetch ftp://sven:svenpass@192.168.1.40/textconfig

The arguments are as follows:

●

filename—Gives the retrieved file a new name on the GigaVUE H Series node. For example, the following command retrieves textconfig and names it newtextconfig on the node:

(config) # configuration text fetch scp://bbochy:catch1@192.168.1.75/myconfig filename newconfig

Use the following arguments to control how errors are handled and reported:

fail-continue—Include this option if you want to continue executing commands if one fails. If this option is not included, the process halts on the first error.

verbose—Include this option if you want to see all commands printed to the screen as they are applied. If this option is not included, only commands resulting in errors (or output) appear in the CLI.

overwrite—Overwrites the filename if the destination filename already exists.

apply—Retrieves the text configuration file and applies it to the running configuration at the same time. For example, here is the previous command with the apply switch added:

(config) # configuration text fetch scp://bbochy:catch1@192.168.1.75/myconfig filename newconfig apply verbose fail-continue

If you include the apply argument, you can also include the discard option to specify that the text file be discarded once the commands are applied. Note that the discard option is mutually exclusive with the filename option. For example, here is a version of the previous command that will apply the text configuration file and discard it afterwards:

(config) # configuration text fetch scp://bbochy:catch1@192.168.1.75/myconfig apply discard verbose fail-continue

text
   file <filename>
      apply [fail-continue] [verbose]
      delete      rename <filename>
      upload <upload URL>

Applies a text-based configuration file to the running configuration, or deletes, renames, or uploads a specified file to an external server using FTP, TFTP, or SCP.

Applying a Text Configuration File

For example, the following command applies the text configuration file named textconfig:

(config) # configuration text file textconfig apply

Use the following arguments to control how errors are handled and reported:

●

fail-continue—Include this option if you want to continue executing commands if one fails. If this option is not included, the process halts on the first error.

●

Deleting a Text Configuration File

Use the delete argument to delete a text configuration file. For example:

(config) # configuration text file myconfig delete

Renaming a Text Configuration File

Use the rename argument to rename a text configuration file. For example:

(config) # configuration text file myconfig rename your config

Uploading a Text Configuration File

Use the upload argument to send a text configuration file to an external server using FTP, TFTP, or SCP. The format for the upload URL is as follows:

[protocol]://username[:password]@hostname/path/filename

For example, the following command uses SCP to upload myconfig to 192.168.1.212:

(config) # configuration text file myconfig upload scp://bposey:catch1@192.168.1.212

text   generate
      active running <only-traffic> <save          <filename>> | <upload <upload URL>>
      active saved <only-traffic> <save          <filename>> | <upload <upload URL>>
      file <filename | initial> <save <filename>> |          <upload <upload URL>>

Generates a text-based configuration file from the system configuration. The text file can be saved locally or uploaded to a remote host.

Text configuration files list the CLI commands used to create a particular configuration. They can be applied using the configuration text file <filename> apply command.

The available sources for a text configuration file are as follows:

●

active running—The currently running configuration, complete with any unsaved changes to the active configuration file.

●

active saved—The last saved version of the active configuration file.

●

active running only-traffic—The only-traffic text configuration of the currently running configuration, complete with any unsaved changes to the active configuration file. Only-traffic means the text file will contain only the traffic-related configuration.

●

active saved only-traffic—The only-traffic text configuration of the last saved version of the active configuration file. Only-traffic means the text file will contain only the traffic-related configuration.

●

file <filename>—The named configuration file of an inactive saved configuration.

Each text configuration file can be saved or uploaded as follows:

●

save <filename>—Specifies saving the text file to persistent storage.

●

upload <upload URL>—Specifies uploading the text file to a remote host. Use FTP, TFTP, SCP, or SFTP to upload the file. The format for the upload URL is as follows:

[protocol]://username[:password]@hostname/path/filename

For example, the following command uploads a text configuration file based on the active running configuration and uploads it to an FTP server at 192.168.1.49:

(config) # configuration text generate active running upload ftp://myuser:mypass@192.168.1.49

Uploaded text configuration files are automatically named with a timestamp in epoch format. For example:

config-text-1308003659

You can also generate text configuration files and save them to local storage. For example:

(config) # configuration text generate active running save myfile.txt

You can also generate traffic-only text configuration files and save them locally. For example:

(config) # configuration text generate active running only-traffic save myfile.txt

(config) # configuration text generate active saved only-traffic save myfile.txt

You can also generate traffic-only text configuration files and upload them. For example:

(config) # configuration text generate active running only-traffic upload scp://username@192.168.1.105

(config) # configuration text generate active saved only-traffic upload ftp://myuser:mypass@192.168.1.49

upload <inital> | active <upload URL>

Uploads a configuration file to a remote host. Use FTP, TFTP, or SCP to upload the file. The format for the upload URL is as follows:

[protocol]://username[:password]@hostname/path/filename

For example, the following command sends the configuration file named gigavue to the FTP server at 10.160.10.212 using the ramrod account with the xyz123 password:

(config) # configuration upload gigavue ftp://ramrod:xyz123@10.160.10.212

You can also use the active argument to upload the active configuration file. The uploaded file will have the same name as the active file.

(config) # configuration upload active scp://bposey:catch1@192.168.1.212

write [local | to <filename>] [no-switch]

Saves the running configuration to storage.

You can save locally or to a currently active file or a named file. For example:

●

(config) # configuration write

Saves the running configuration to the active configuration file. If you run this command on a leader leader in clustering node relationship (formerly master) node, it is propagated to all the nodes in the cluster.

●

(config) # configuration write local

On a system with clustering, saves the running configuration on the local node.

●

(config) # configuration write to myconfig

Saves the running configuration to a named file and makes it active. In the above example, myconfig is the name of the file. This is local to the node on which the command is run and is not propagated to other nodes in the cluster.

●

(config) # configuration write to myconfig no-switch

Saves the running configuration to the myconfig file and leaves the current configuration file active.

Related Commands

The following table summarizes other commands related to the configuration command:

Task

Command

Displays commands to recreate active saved configuration.

# show configuration

Displays settings for configuration change auditing.

# show configuration audit

Displays a list of configuration files.

# show configuration files

Displays the commands in a configuration file to recreate the configuration.

# show configuration files file1

Does not exclude commands that set default values.

# show configuration full

Displays commands to recreate current running configuration.

# show configuration running

Does not exclude commands that set default values.

# show configuration running full

Displays names of available text-based configuration files.

# show configuration text files

Displays the commands necessary to recreate the current running configuration.

Use either of the following:

●

(config) # write terminal

●

# show running-config