Library Table of Contents Index Previous Next Comments

About global configuration files

What are global configuration files?  Top

The appliance command line interface (CLI) enables the administrator to apply a common set of configuration settings contained in one or more centrally located global configuration text files to multiple appliances on the network.

Later, by manually editing or reconfiguring one or more configuration settings in the global configuration files, the administrator effectively reconfigures those settings for all appliances using these files.

Default configuration files  Top

Every configuration setting that you view or make through the Setup tab pages in the Appliance Manager is recorded as one or more parameters in configuration files on the appliance.

Two configuration files exist by default or are automatically generated by the appliance software as you install the appliance and configure it through the Appliance Manager Web pages or the CLI:

When the appliance software boots up, the local appliance determines its active configuration by reading default.cfg settings first and local.cfg settings last. Settings in the last read file, local.cfg, overwrite any conflicting settings in any previously read files, in this case, default.cfg.

Viewing local.cfg values  Top

To view local changes made by administrators to the appliance, enter the following CLI command:

show $local.cfg:config.*

User-generated global configuration files  Top

The administrator can create customized global configuration text files containing appliance settings to be stored on a source server or a source appliance and applied uniformly to a set of target appliances. The administrator can then configure those target appliances to periodically read the settings in the global configuration files and incorporate the global configuration file settings into each target appliance's active configuration.

When global configuration files are applied

Global configuration file settings are meant to be applied by each appliance after the default.cfg settings, but before its local.cfg settings. If the settings in the global configuration file conflict with the local.cfg settings, local.cfg settings are applied. Settings in the last-applied configuration file overwrite any conflicting settings in previously applied configuration files.

How global settings are propagated

The following table describes how centrally configured settings in global configuration files can be applied to all appliances in a network.

.

Global configuration file propagation process

Global configuration file source server or appliance

Global configuration file target appliances

ServerA

.cfg files

ApplianceA .cfg files

ApplianceB .cfg files

ApplianceC .cfg files

All appliances have default configuration files.

--

default.cfg

local.cfg

default.cfg

local.cfg

default.cfg

local.cfg

The administrator creates, configures, and saves to ServerA or source ApplianceA one or more global configuration files containing settings to be applied uniformly to all appliances.

globlac.cfg

globlbw.cfg

N/A

default.cfg

local.cfg

default.cfg

local.cfg

N/A

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

local.cfg

default.cfg

local.cfg

The administrator then configures the target appliances to periodically read the global configuration files from the source server or appliance and incorporate the global settings in their active configuration.

Alternatively, the administrator manually pushes configuration files to local drives on target appliances and configures the target appliances to read those files.

globlac.cfg

globlbw.cfg

N/A

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

N/A

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

Any subsequent changes that the administrator makes to a global configuration file on ServerA or source ApplianceA are periodically propagated to target ApplianceB and ApplianceC.

Alternatively, the administrator manually pushes the modified configuration file to local drives on the target appliances.

globlacl.cfg

globlbw.cfg

N/A

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

N/A

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

default.cfg

globlacl.cfg

globlbw.cfg

local.cfg

What do global configuration files contain?  Top

The settings in global configuration files consist of a version number and a list of configuration option strings and values specifying the appliance settings that the administrator wants to apply globally.

Version line

The first line of the file specifies the version of the appliance with which the option strings that follow are compliant. The syntax of the version line is:

#!Config Vx.xxx 

where x.xxx is the appliance version number.

Option strings

The option strings are the same strings used with the set command when configuring an appliance through the CLI, the same option strings that appear if you enter show config.* in the CLI console.

The syntax for each setting is:

config.option_string =valid_appliance_value

For example, a global configuration file named globlbw.cfg might contain the following streaming settings, which the administrator might want to apply uniformly to all the appliances in the network:

config.streaming.rulelist.bandwidth = //

allow group ourgroup and bitrate 0k - 140k

allow group theirgroup and bitrate 0k - 56k

allow time 7am - 7pm and bitrate 0k - 56k

deny any

//

config.streaming.rulelist.cacheability = //

no-cache server-name www.mine.com

no-cache not group finance

no-cache bitrate 1Mbps

//

For a complete listing of CLI config.* option strings, see the configuration option reference table in the Command Line Reference.

Ways to create a global configuration file  Top

Global configuration files are text files. They can be created either manually or by redirecting the output of the CLI show command.

Manually creating a configuration file

Using a text editor on a server where you want to locate your global configuration files, you can manually create a global configuration file and its entries if you are familiar with the CLI option strings.

Cloning the configuration of an existing appliance

Using the CLI show -clone command, redirect the show -clone command output of an existing appliance configuration to a configuration file on an FTP or HTTP server. For example:

show -clone > ftp://srvrz:cfg/multicache1.cfg 

Then edit that file to contain only the settings that you want to apply globally over multiple appliances.

Note
If you manually create a global configuration file, begin the file with the following version line string: #!Config Vx.xxx where x.xxx is the appliance version number that your option strings are complaint with.

Generating a configuration file using show config.*

Using the settings of a source appliance that has already been configured through the Appliance Manager, you can generate a configuration file by completing the following steps.

Step

Action

1

Using the Appliance Manager, configure a local appliance with the settings that you want to include in the global configuration file.

As each page is configured, click Commit Changes at the bottom of that page.

2

In the CLI console, enter the show command and redirect its output to a text file either on a server with HTTP or FTP connectivity or on the source appliance itself.

  • If you want to redirect to an HTTP or FTP server, enter
    show config.partial_option_string* > 
    {ftp|http}://[usr:pw@]srvr/path/file
    

    partial_option_string is a partially complete CLI configuration option string that, in combination with an asterisk, specifies the subset of configuration settings that you want directed to a global configuration file.

    usr:pw is the login name and password, if any, necessary to write to the source server where the global configuration file will be written.

    srvr/path/sfile is the server, directory, and file name where the global configuration will be located.

    path/file is the directory location and file name on the server where you want the global configuration file written.

    For example:

    show config.acl* >ftp://admn:secrt 
    @serverC//configz/globacl.cfg
    
  • If redirecting to a location on the source appliance, enter
    show config.partial_option_string* > path/file
    

    Example:

    show config.acl* > /temp/globacl.cfg
    
3

If you redirected the global configuration file to a server, you can use a text editor to make any necessary edits to the file.

If you redirected the global configuration file to a location on the source appliance, you cannot edit the file directly.

Note
In either case, the appliance automatically includes the required appliance version line at the start of the resulting file.

Editing the configuration file settings to append rather than overwrite  Top

To append to rather than overwrite values for matching settings specified in earlier configurations, edit your later configuration file settings, replacing the = character with the += character combination.

In the following table, Example 1 shows the config.auth.users setting in global configuration file A overwritten by the matching setting in global configuration file B. Example 2 shows the config.auth.users setting in global configuration file A appended to by the matching setting in global configuration file B.

Examples

Setting in global configuration file A

Setting in global configuration file B

Resulting active setting in Appliance10

Example 1: overwritten settings

config.auth.
users = jack@abc.com

config.auth.
users = jill@abc.com

config.auth.
users = jill@abc.com

Example 2: appended settings

config.auth.
users = jack@abc.com

config.auth.
users += jill@abc.com

config.auth.
users=\\ jack@abc.com jill@abc.com

\\

Inserting comment lines in global configuration files  Top

If you manually edit your configuration files, you can use the # character to set off comment lines. For example:

# The following section sets bandwidth allocation 

# Do not change!

Note
Comment lines starting with the # character in the source global configuration file will be stripped out of the active configuration that is pulled or cloned to target appliances. Restore operations from target appliances to global configuration source files will overwrite all comment lines.

Library Table of Contents Index Previous Next Comments