configutil (Sun Java System Messaging Server 6 2005Q4 Administration Reference)

Sun Java System Messaging Server 6 2005Q4 Administration Reference

configutil

The configutil utility enables you to list and change Sun Java System Messaging Server configuration parameters.

For a list of all configuration parameters, see Chapter 3, Messaging Server Configuration.

Most Sun Java System Messaging Server configuration parameters and values are stored in the LDAP database on Directory Server. The remaining parameters and values are stored locally in the msg.conf and local.conf files. The startup parameters are stored in the msg.conf file and are set during installation. The local.conf files should not be edited manually. Use configutil to edit the parameters stored in those files.

Note –

If the administrator has defined any language-specific options (such as messages), you must use the language option at the end of the command in order to list or change them. Commands entered without a language option are only applied to attributes that do not have a specified language parameter.

Requirements: Must be run locally on the Messaging Server. You may run configutil as root or mailsrv. If you make changes to the servers, you must restart or refresh the servers, depending on the variable, for the changes to take effect.

Location: msg_svr_base/sbin/configutil

You can use configutil to perform four tasks:

Display particular configuration parameters using -o option.
- Add ;lang-xx after the option to list parameters with a specified language parameter. For example, ;lang-jp to list options specified for the Japanese language.
List configuration parameter values using the -l or -p prefix options. (Can be used with the -m option.)
- Use -l to just list local configuration parameters from the server’s local configuration file.
- Use -p prefix to just list those configuration parameters whose names begin with the letters specified in prefix.
- Use -m to show whether or not the listed parameters are refreshable.
Set configuration parameters using the -o option and -v value options.
- Include the -l option with -o option and -v value to store the new value in the server’s local configuration file.
- To read the actual value from stdin, specify a dash (-) as the value on the command line.
- Add ;lang-xx after the option to set options for a specified language parameter. For example, ;lang-jp to set options specified for the Japanese language.
Import configuration parameter values from stdin using the -i option.
- Include the -l option with the -i option to import all configuration parameters to the server’s local configuration file.

Syntax

configutil [-f configdbfile] [-l] -o option[;language] [-v value]
configutil [-f configdbfile] [-p prefix[;language]] [-m]
configutil -i inputfile

Options

The options for this command are:

Option	Description
`-f` `configdbfile`	Enables you to specify a local configuration file other than the default. (This option uses information stored in the `CONFIGROOT` environment variable by default.)
`-i` `inputfile`	Imports configurations from a file. Data in the file to be entered in `option=value` format with no spaces on either side of the pipe. The `inputfile` should be specified as an absolute path.
`-l`	Lists configuration parameters stored in the local server configuration file. When used in conjunction with the `-v` option, specifies that a configuration parameter value be stored in the local server configuration file. The `-l` option bypasses the schema checking and only stores the information in the local copy. If you use `-l` to store an option that is defined in the schema, then it will only be effective if the config DS is unavailable. As soon as the config DS is available, the local copy will be overwritten with the value from the config DS. Therefore, the `-l` is really only useful in setting options which are not already defined in the schema.
`-m`	Displays whether or not the listed options are refreshable.
`-o` `option`	Specifies the name of the configuration parameter that you wish to view or modify. May be used with the `-l` and `-i` options. Configuration parameter names starting with the word `local` are stored in the local server configuration file.
`-p` `prefix`	Lists configuration parameters with the specified prefix.
`-v` `value`	Specifies a value for a configuration parameter. To be used with `-o` `option`. If the `-l` option is also specified or the configuration parameter name specified with the `-o` option begins with `local`, the option value is automatically stored in the local server configuration file rather than the Directory Server.

If you specify no command-line options, all configuration parameters are listed.

Examples

To list all configuration parameters and their values in both the Directory Server LDAP database and local server configuration file:

configutil

To import configurations from an input file named config.cfg:

configutil -i config.cfg

To list all configuration parameters with the prefix service.imap:

configutil -p service.imap

To display the value of the service.smtp.port configuration parameter:

configutil -o service.smtp.port

To set the value of the service.smtp.port configuration parameter to 25:

configutil -o service.smtp.port -v 25

To clear the value for the service.imap.banner configuration parameter:

configutil -o service.imap.banner -v ""

To display the refreshable status of the service.pop configuration parameters:

configutil -m -p service.pop

This example of the -m option could produce the following sample output:

service.pop.allowanonymouslogin = no [REFRESHABLE]
service.pop.banner = "%h %p service (%P %V)" [REFRESHABLE]
service.pop.createtimestamp = 20030315011827Z [REFRESHABLE]
service.pop.creatorsname = "cn=directory manager" [REFRESHABLE]
service.pop.enable = yes [NOT REFRESHABLE]
service.pop.enablesslport = no [NOT REFRESHABLE]
service.pop.idletimeout = 10 [REFRESHABLE]
service.pop.maxsessions = 600 [NOT REFRESHABLE]
service.pop.maxthreads = 250 [NOT REFRESHABLE]

Language Specific Options

To list or set options for a specific language, append ;lang-xx immediately after the option with no spaces, where xx is the two-letter language identifier. For example, to view the text of the Japanese version of the store.quotaexceededmsg message:

configutil -o "store.quotaexceededmsg;lang-jp"

The semicolon is a special character for most UNIX shells and requires special quoting as shown in the example.