2.7 Using Messaging Agent Startup Switches

You can override settings provided in the GroupWise Admin console by using startup switches in the Messaging Agent startup file (strtup.ma). The startup file is located in /etc/opt/novell/messenger. You can override startup switches provided in the startup file by using startup switches on the command line. For more information about starting the Messaging Agent, see Starting the Messaging Agent.

This section contains information on the following startup switches:

The following table summarizes the Messaging Agent startup switches and how they correspond to configuration settings in the GroupWise Admin console.

Table 2-2 Messaging Agent Startup Switches

Messaging Agent

GW Admin Console Setting

--certfile

SSL Certificate

--certpath

Certificate Path

--dhparm

N/A

--httppassword

HTTP Password

--httpport

HTTP Port

--httpuser

HTTP Username

--httpssl

Enable SSL for Web Console

--ip

Host IP Address with Bind to this Address selected

--keepalive

N/A

--keyfile

SSL Key File

--keypassword

SSL Set Password

--log

Log Files Path

--logdays

Log Maximum Age

--logdiskoff

Enable Disk Logging

--loglevel

Log Level

--logmax

Log Maximum Size

--maxconns

Maximum Number of Users

--nosnmp

Enable SNMP

--port

Client/Server Port

--productinfo

N/A

--sslciphersuite

N/A

--ssloption

N/A

--threads

Client/Server Threads

2.7.1 /certfile

Specifies the full path to the certificate files used to provide secure SSL communication between the Messaging Agent and other programs. See Configuring the Messaging Agent with SSL Encryption.

 

Linux Messaging Agent

Syntax:

--certfile=/dir/file

Example:

--certfile=/certs/gw.crt

See also /certpath, /keyfile, and /keypassword.

2.7.2 /certpath

Specifies the full path to the directory where certificate files are stored on your system. See Configuring the Messaging Agent with SSL Encryption.

 

Linux Messaging Agent

Syntax:

--certpath=/dir

Example:

--certpath=/certs

See also /certfile, /keyfile, and /keypassword.

2.7.3 /dhparm

Specifies a Diffie-Hellman cipher parameters file used for SSL/TLS to replace the default parameters set by Messenger. Messenger uses default Diffie-Hellman parameters of 2048 bits to generate the DH key. A valid DH parameter is in PEM format.

 

Linux Messaging Agent

Syntax:

--dhparm directory/pemfile

Example:

--dhparm /var/tmp/dh.pem

2.7.4 /httppassword

Specifies the password for the Messaging Agent to prompt for before allowing Messaging Agent status information to be displayed in your browser. Unless you are using SSL encryption, do not use an existing LDAP password because the information passes over the connection between your browser and the Messaging Agent. See Using the Messaging Agent Web Console.

 

Linux Messaging Agent

Syntax:

--httppassword= unique_password

Example:

--httppassword=AgentWatch

See also /httpuser.

2.7.5 /httpport

Sets the HTTP port number used for the Messaging Agent to communicate with your browser. The setting must be unique on the server where the Messaging Agent runs. See Using the Messaging Agent Web Console.

 

Linux Messaging Agent

Syntax:

--httpport=port_number

Example:

--httpport=8315

2.7.6 /httpssl

Sets the availability of SSL encryption between the Messaging Agent and the Web Console displayed in your browser. Valid values are enable and disable. See Using the Messaging Agent Web Console.

 

Linux Messaging Agent

Syntax:

--httpssl=setting

Example:

--httpssl=enable

2.7.7 /httpuser

Specifies the user name for the Messaging Agent to prompt for before allowing Messaging Agent status information to be displayed in a browser. Providing a user name is optional. Unless you are using SSL encryption, do not use an existing LDAP user name because the information passes over the connection between your browser and the Messaging Agent. See Using the Messaging Agent Web Console.

 

Linux Messaging Agent

Syntax:

--httpuser=unique_username

Example:

--httpuser=NMWebConsole

See also /httppassword.

2.7.8 /ip

Binds the Messaging Agent to a specific IP address when the server where it runs uses multiple IP addresses, such as in a clustering environment. Without the /ip switch, the Messaging Agent binds to all available IP addresses and Messenger clients can communicate with the Messaging Agent on all available IP addresses.

 

Linux Messaging Agent

Syntax:

--ip=IP_address

Example:

--ip=172.16.5.19

2.7.9 /keepalive

Adjusts the default ping interval at which the Messenger clients notify the Messaging Agent that they are still active. The default interval is every 10 minutes. This regular communication between the Messaging Agent and the client prevents firewalls and routers from disconnecting connections that seem to be inactive. You can decrease the interval if client users are being unexpectedly disconnected. You can increase the interval to decrease network traffic. Use a setting of 0 (zero) to turn off the ping activity.

 

Linux Messaging Agent

Syntax:

--keepalive=minutes

Example:

--keepalive=5

The ping interval can be adjusted for individual clients by using the /keepalive startup switch with the Messenger client.

2.7.10 /keyfile

Specifies the full path to the private file used to provide SSL encryption between the Messaging Agent and other programs. See Configuring the Messaging Agent with SSL Encryption.

 

Linux Messaging Agent

Syntax:

--keyfile=/dir/file

Example:

---keyfile=/certs/gw.key

See also /keypassword.

2.7.11 /keypassword

Specifies the password used to encrypt the private SSL key file when it was created. See Configuring the Messaging Agent with SSL Encryption.

 

Linux Messaging Agent

Syntax:

--keypassword=password

Example:

--keypassword=gwssl

See also /keyfile.

2.7.12 /log

Specifies the directory where the Messaging Agent will store its log files. The default location is the \novell\nm\ma\log directory. See Using Messaging Agent Log Files.

 

Linux Messaging Agent

Syntax:

--log=/dir

Example:

--log=/nm/log/ma

See also /loglevel, /logdays, /logmax, and /logdiskoff.

2.7.13 /logdays

Specifies how many days to keep Messaging Agent log files on disk. The default is 14 days. See Using Messaging Agent Log Files.

 

Linux Messaging Agent

Syntax:

--logdays=days

Example:

--logdays=30

See also /log, /loglevel, /logmax, and /logdiskoff.

2.7.14 /logdiskoff

Turns off disk logging for the Messaging Agent so no information about the functioning of the Messaging Agent is stored on disk. The default is for logging to be turned on. See Using Messaging Agent Log Files.

 

Linux Messaging Agent

Syntax:

--logdiskoff

See also /log, /loglevel, /logdays, and /logmax.

2.7.15 /loglevel

Controls the amount of information logged by the Messaging Agent. Logged information is displayed in the log message box and written to the Messaging Agent log file during the current agent session. The default is Normal, which displays only the essential information suitable for a smoothly running Messaging Agent. Use Verbose to display the essential information, plus additional information helpful for troubleshooting. Use Diagnostic to include very detailed, code-specific information. See Using Messaging Agent Log Files.

 

Linux Messaging Agent

Syntax:

--loglevel=level

Example:

--loglevel=diagnostic

See also /log, /logdays, /logmax, and /logdiskoff.

2.7.16 /logmax

Sets the maximum amount of disk space for all Messaging Agent log files. When the specified disk space is consumed, the Messaging Agent deletes existing log files, starting with the oldest. The default is 128 MB. See Using Messaging Agent Log Files.

 

Linux Messaging Agent

Syntax:

--logmax=megabytes

Example:

--logmax=256

See also /log, /loglevel, /logdays, and /logdiskoff.

2.7.17 /maxconns

Specifies the maximum number of connections between the Messaging Agent and Messenger clients. The default is 5120. See Optimizing Messaging Agent Performance.

 

Linux Messaging Agent

Syntax:

--maxconns=connections

Example:

--maxconns=10000

See also /threads.

2.7.18 /nosnmp

Disables SNMP for the Messaging Agent. The default is to have SNMP enabled. See Using SNMP Monitoring Programs.

 

Linux Messaging Agent

Syntax:

--nosnmp

2.7.19 /port

Sets the port number on which the Messaging Agent listens for service requests from Messenger clients. The default is 8300. See Configuring the Messaging Agent.

 

Linux Messaging Agent

Syntax:

--port=port_number

Example:

--port=8302

2.7.20 /productinfo

Sets the level of anonymous product information is sent to Micro Focus. The level is initially set during the install or upgrade. The following options are available:

  • 0: Turns off anonymous product information collection.

  • 1: Enables basic collection which collects the uptime, product version, OS type, and number of peak users.

  • 2: Enables basic collection additional data collection which adds message traffic, chat room usage, number of conversations, and other similar information.

 

Linux Messaging Agent

Syntax:

--productinfo=value

Example:

--productinfo=1

2.7.21 /sslciphersuite

Sets the SSL cipher suites used by the Archive Agent, the Messaging Agent, and Messenger clients. The cipher list must be in OpenSSL format. The default cipher string is located in the agent startup files and may be updated from time to time in newer installations. For more information on OpenSSL format, see Cipher List Format.

 

Linux Messaging Agent

Syntax:

--sslciphersuite “setting”

Example:

--sslciphersuite “HIGH:!AECDH:!EXP:@STRENGTH”

2.7.22 /ssloption

Specify a specific SSL protocol to disable. By specifying SSL_OP_NO_TLSv1, Messenger will disable TLSv1 support. Specify additional options by adding the SSL key work separated by a comma.

 

Linux Messaging Agent

Syntax:

--ssloption SSL_protocol

Example:

--ssloption SSL_OP_NO_TLSv1,SSL_OP_NO_TLSv1_1

2.7.23 /threads

Specifies the maximum number of client/server threads the Messaging Agent can create. The default is 15. See Optimizing Messaging Agent Performance.

 

Linux Messaging Agent

Syntax:

--threads=number

Example:

--threads=20

See also /maxconns.