bcfg(1)

NAME
bcfg - Interactive configuration utility.

SYNOPSIS
bcfg -I inputfile [-S server] [-U username] [-P password] [-E]

or

bcfg -O outputfile [-S server] [-U username] [-P password] [-E]

or

bcfg ID value [-S server] [-U username] [-P password]

or

bcfg -H <keyword | "keyword with spaces"> [-S server] [-U username] [-P password]

DESCRIPTION
bcfg is used from the command line to configure settings for a Zen Server or Client. You can configure one setting at a time or provide one or more settings in an input file.

OPTIONS

-I  Required parameter if you provide an input file to the utility.

inputfile
    A text file that contains one or more configuration setting records for a specified server and the value assigned to each setting. A convenient way to create an input file is first to create an output file. You can then edit the setting values as required and use the edited version as an input file.

-O  Required parameter if you want the output results of running the utility sent to a text file.

outputfile
    A text file that contains the current configuration settings for a specified server as a result of running the utility.

ID  A two or three digit integer that uniquely identifies the configuration setting. Some configuration settings require that you restart the database engines for the setting to take effect. Bcfg prompts you if a restart is required.

value
    A value assigned to the configuration setting. The valid values are specified in a setting record in Options or Range. If Value is omitted, the utility returns the current setting. If Value is included, the utility changes the setting based on the value assignment.

-H  The help search option for a keyword (that is, help for a keyword). The utility searches for configuration settings that contain the keyword and returns the ID and setting name, or returns no matches found.

keyword
    The name of the configuration setting, such as ALLOW CLIENT-STORED CREDENTIALS or SUPPORTED PROTOCOLS. Note that keyword is case insensitive. However, if the keyword contains one or more spaces, you must double quote the string. The utility can provide help based on partial keywords. For example, if you specify -H client, the utility returns all setting with the word "client" as part of the setting name. If you specify -H a, the utility returns all settings with an "a" in the name.

-S  Required parameter if the configuration settings apply to a remote server (a server other than the local one).

server
    The name or IP address of the remote server that contains the database engine.

-U  Required parameter if a user name is required to access server.

username
    User name with which you will connect to server.

-P  Required parameter if a password is required to access server.

password
    Password used with username to connect to server.

-E  Ignore errors when reading inputfile or writing to outputfile.

EXAMPLES

  Configuring a Single Setting from the Command Line

Suppose that you want to turn on a configuration setting having to do with reconnecting a client to the server in the event of a network outage. You are not certain about the name of the configuration setting. Complete the following steps.

At a command prompt, type bcfg -H reconnect then press Enter. The utility reports all settings that contain the string "reconnect":

ID Setting Name

-----------------------------

29 Enable Auto Reconnect

148 Enable Auto Reconnect

149 Auto Reconnect Timeout

Two of the settings, 29 and 148, look like what you want, but which is which?

Type bcfg 29 then press Enter. The utility reports the following for setting ID 29:

=====================

ENABLE AUTO RECONNECT

=====================

ID: 29

Value: Off

Options: On Off

Default Value: Off

Description: <Client setting> Specifies if the Client will attempt to reconnect to the Server in the event of a network outage. The reconnected Client will continue processing as if no errors were encountered. The description tells your that this setting applies to a client and that the setting is currently "off."

Type bcfg 29 and then press Enter.

The utility informs you that system setting 29 has been updated.

If you want to verify that the setting is now "on," type bcfg 29 then press Enter.

The utility reports the following for setting ID 29:

=====================

ENABLE AUTO RECONNECT

=====================

ID: 29

Value: On

Options: On Off

Default Value: Off

Description: <Client setting> Specifies if the Client will attempt to reconnect to the Server in the event of a network outage. The reconnected Client will continue processing as if no errors were encountered.

Note that the value is now set to "on."

  Editing an Input File

An input file must contain at least one complete record for one setting. If you create an input file from an output file and want to remove configuration settings, ensure that the remaining settings are complete records. At a minimum, a complete record encompasses and ID and Value pair. However, to ensure clarity, it is recommended that you include the top line of the setting header through the description of the setting. For example, here is a suggested minimal record for Enable Auto Reconnect:

=====================

ENABLE AUTO RECONNECT

=====================

ID: 29

Value: On

Options: On Off

Default Value: Off

Description: <Client setting> Specifies if the Client will attempt to reconnect to the Server in the event of a network outage. The reconnected Client will continue processing as if no errors were encountered. Other than limiting which setting records are included in the input file, the only other change allowed is to the Value assignments. The assignment can be whatever is specified by Options or by Range.

SEE ALSO
Advanced Operations Guide for more information about the bcfg utility.