configutil (Sun Java System Messaging Server 6.3 Administration Reference)

Sun Java System Messaging Server 6.3 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.

AllSun Java System Messaging Server configuration parameters and values are stored locally in the msg.conf and msg.conf.defaults files. The msg.conf.defaults file must never be edited and contains defaults constructed during initial configuration. The msg.conf file contains settings that have been explicitly overridden from their default value using configutil. Use the -H option to configutil to view a setting's default value.Use configutil to edit configutil settings; do not edit these files directly.

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 -p pattern option. (Can be used with the -m option.)
- Use -p pattern to just list those configuration parameters whose names contain the pattern specified in pattern. * is the wildcard character and is assumed to follow pattern if there is no wildcard already in pattern.
- Use -m to show whether or not the listed parameters are refreshable.
Set configuration parameters using the -o option and -v value options.
- 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 -H option to show settings with help.

Examples:

# ./configutil -H

Configuration option: alarm.diskavail.msgalarmdescription
        Description: Description for the diskavail alarm.
        Syntax: string
        Default: percentage mail partition diskspace available
alarm.diskavail.msgalarmdescription is currently set to: percentage mail
partition diskspace available

Configuration option: alarm.diskavail.msgalarmstatinterval
        Description: Interval in seconds between disk availability
checks. Set to 0 to disable checks of disk usage.
        Syntax: int
        Default: 3600
alarm.diskavail.msgalarmstatinterval is currently set to: 3600
[.....]

### Show help on all configuration parameters ending in ".port" 

# ./configutil -p \*.port -H
Configuration option: local.ens.port
        Description: Port (and optionally, a specific IP address) ENS
server will listen on, in the format of [address:]port, for example,
7997 or 192.168.1.1:7997.
        Syntax: string
        Default: 7997
local.ens.port is currently set to: 7997

Configuration option: local.service.http.proxy.port
        Description: Configures the port number of the back-end
Messenger Express (HTTP) server with the Messaging Multiplexor.
        Syntax: uint
        Default: 80
local.service.http.proxy.port is currently set to: 80

Configuration option: local.snmp.port
        Description: SNMP subagent port number.
        Syntax: uint
        Default: 0
local.snmp.port is currently set to: 0

Configuration option: local.watcher.port
        Description: watcher listen port.
        Syntax: uint
        Default: 49994
local.watcher.port is currently set to: 49994

Configuration option: local.webmail.cert.port
        Description: Specifies a port number on the machine where the
Messaging Server runs to use for CRL communication. This port is used
locally for that machine only. The value must be greater than 1024.
        Syntax: int
        Default: 55443
local.webmail.cert.port is currently set to: 55443

Configuration option: local.webmail.da.port
        Description: Delegated Administrator port.
        Syntax: int
        Default: 8080
local.webmail.da.port is currently set to: 8080

Configuration option: local.webmail.sieve.port
        Description: The port of the web container where the Mail Filter
has been deployed.
        Syntax: string
        Default: NULL (unset)
local.webmail.sieve.port is currently unset

Configuration option: metermaid.config.port
        Description: Port number on which MeterMaid listens for
connections.
        Syntax: tcpport
        Default: 63837
metermaid.config.port is currently set to: 63837

Configuration option: service.http.port
        Description: Messenger Express HTTP port.
        Flags: MSG_RESTART_HTTP
        Syntax: uint
        Default: 80
service.http.port is currently set to: 81

Configuration option: service.imap.port
        Description: IMAP server port number.
        Flags: MSG_RESTART_IMAP
        Syntax: uint
        Default: 143
service.imap.port is currently set to: 143

Configuration option: service.pop.port
        Description: POP server port number.
        Flags: MSG_RESTART_POP
        Syntax: uint
        Default: 110
service.pop.port is currently set to: 110

### Show help on store.partition.\*.path

# ./configutil -p store.partition.\*.path -H
Configuration option: store.partition.*.path
        Description: Controls the store index file directory path.
        Flags: MSG_RESTART_ALL
        Syntax: filepath
        Default: NULL (unset)
store.partition.primary.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/primary
store.partition.three.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/three
store.partition.two.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/two

Configuration option: store.partition.primary.path
        Description: Full path name of the primary partition.
        Flags: MSG_RESTART_ALL
        Syntax: filepath
        Default: <msg.RootPath>/data/store/partition/primary
store.partition.primary.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/primary

Syntax

configutil [-h] [-f configfile] [-o option[;language] [-v value]
configutil [-f configfile] [-p pattern] [-H] [-m] [-V]
configutil -i inputfile

Options

The options for this command are:

Option	Description
`-d`	Enables you to delete an option. Used with the `-o` option.
`-f` `configfile`	Enables you to specify a local configuration file other than the default. (This option uses information stored in the `CONFIGROOT` environment variable by default.)
`-h`	Shows usage statement.
-H	Enables you to get help on options. Used with the `-o` option.
`-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.

`-m`	Lists meta data.
`-o` `option`	Specifies the name of the configuration parameter that you wish to view or modify. May be used with the `-H`, `-v`, `-d` options. Configuration parameter names starting with the word `local` are stored in the local server configuration file.
`-p` `pattern`	Lists only options with the given pattern (* is wildcard). Example: configutil `- p \enable -H` If no wildcard is present in the `pattern`, a wildcard at the end of the `pattern` will be assumed (effectively changing `pattern` to `pattern\`).
`-v` `value`	Specifies a value for a configuration parameter. To be used with `-o` `option`.
`-V`	Enables you to validate the configuration against meta data.

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.