5.13 Using Archive Agent Startup Switches

You can override settings provided in ConsoleOne by using startup switches in the Archive Agent startup file (strtup.aa). On Windows, the startup file is located in the Messenger Agent installation directory. On Linux, 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 Archive Agent, see Section 5.2, Starting the Archive Agent.

This section contains information on the following Archive Agent startup switches:

The table below summarizes the Archive Agent startup switches and how they correspond to configuration settings in ConsoleOne. These startup switches must begin with a dash (-) when used in the Cross-Platform client.

Table 5-5 Archive Agent Startup Switches

Linux Archive Agent

Windows Archive Agent

ConsoleOne Setting

--certfile

/certfile

SSL Certificate

--certpath

/certpath

Certificate Path

--dhparm

/dhparm

N/A

--dirdefaultconnections

/dirdefaultconnections

Default Number of Connections (LDAP profile)

--diridletimeout

/diridletimeout

Idle Timeout (LDAP profile)

--dirmaxconnections

/dirmaxconnections

Maximum Number of Connections (LDAP profile)

--dirpoolresettime

/dirpoolresettime

N/A

--dirquerymaxresults

/dirquerymaxresults

Maximum Query Results

--dirreplicaipaddr

/dirreplicaipaddr

N/A

--diruseralias

/diruseralias

N/A

--diruserauthbind

/diruserauthbind

N/A

--diruserforcedirect

/diruserforcedirect

N/A

--home

/home

N/A

--httppassword

/httppassword

HTTP Password

--httpport

/httpport

HTTP Port

--httpuser

/httpuser

HTTP Username

--httpssl

/httpssl

Enable SSL for Web Console

--ip

/ip

Host IP Address with Bind to this Address selected

--keyfile

/keyfile

SSL Key File

--keypassword

/keypassword

SSL Set Password

--language

/language

N/A

--ldapipaddr

/ldapipaddr

LDAP Connection IP Address

--ldapport

/ldapport

LDAP Connection Port

--ldappwd

/ldappwd

LDAP Profile Set Password

--ldapssl

/ldapssl

LDAP Connection SSL Enabled

--ldapsslkey

/ldapsslkey

LDAP Connection Root Certificate

--ldapuser

/ldapuser

LDAP Profile Username

--log

/log

Log Files Path

--logdays

/logdays

Log Maximum Age

--logdiskoff

/logdiskoff

Enable Disk Logging

--loglevel

/loglevel

Log Level

--logmax

/logmax

Log Maximum Size

--maxconns

/maxconns

Maximum Number of Users

--mtpipaddr

/mtpipaddr

Host Address

--mtpport

/mtpport

Message Transfer Port

--mtpssl

/mtpssl

Enable SSL for Message Transfer Protocol

--nomtp

/nomtp

N/A

--nosnmp

/nosnmp

Enable SNMP

--password

/password

Set Password

--port

/port

Client/Server Port

--productinfo

/productinfo

N/A

--queue

/queue

Messaging Queue Path

--sslciphersuite

/sslciphersuite

N/A

--ssloption

/ssloption

N/A

--threads

/threads

Client/Server Threads

--user

/user

Username

5.13.1 /certfile

Specifies the full path to the certificate file used to provide secure SSL communication between the Archive Agent and other programs. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--certfile /dir/file

/certfile-[drive:]\dir\file /certfile-\\svr\sharename\dir\file

Example:

--certfile /certs/gw.crt

/certfile-\novell\nm\ma\certs\nm.crt /certfile-m:\novell\nm\ma\certs\nm.crt /certfile-\\s2\c\novell\nm\ma\certs\nm.crt

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

5.13.2 /certpath

Specifies the full path to the directory where certificate files are stored on your system. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--certpath /dir

/certpath-[drive:]\dir /certpath-\\svr\sharename\dir

Example:

--certpath /certs

/certpath-\novell\nm\aa\certs /certpath-m:\novell\nm\aa\certs /certpath-\\svr2\c\novell\nm\aa\certs

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

5.13.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 Archive Agent

Windows Messaging Agent

Syntax:

--dhparm directory/pemfile

/dhparm directory/pemfile

Example:

--dhparm /var/tmp/dh.pem

/dhparm C:\temp\dh.pem

5.13.4 /dirdefaultconnections

Specifies the minimum number of direct access connections you want open at all times between the Archive Agent and eDirectory. The default is 10 connections.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--dirdefaultconnections number

/dirdefaultconnections-number

Example:

--dirdefaultconnections 30

/dirdefaultconnections-50

See also /diridletimeout and /dirmaxconnections.

5.13.5 /diridletimeout

Specifies the number of seconds after which idle direct access connections in excess of the default number of connections are closed. The default is 30 seconds.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--diridletimeout seconds

/diridletimeout-seconds

Example:

--diridletimeout 60

/diridletimeout-90

See also /dirdefaultconnections.

5.13.6 /dirmaxconnections

Specifies the maximum number of direct access connections you want open between the Archive Agent and eDirectory. The default is 50 connections.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--dirmaxconnections number

/dirmaxconnections-number

Example:

--dirmaxconnections 150

/dirmaxconnections-100

See also /dirdefaultconnections.

5.13.7 /dirpoolresettime

Specifies the number of minutes between the time when the Archive Agent receives an error response from a pooled LDAP server and the time when that LDAP server is reinstated into the pool of available LDAP servers. The default is 5 minutes. See Providing LDAP Access to eDirectory for Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--dirpoolresettime-minutes

/dirpoolresettime-minutes

Example:

--dirpoolresettime-15

/dirpoolresettime-20

5.13.8 /dirquerymaxresults

Specifies the maximum number of query results you want the Archive Agent to return to users in the Messenger client. The default maximum is 100 contacts.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--dirquerymaxresults results

/dirquerymaxresults-results

Example:

--dirquerymaxresults 150

/dirquerymaxresults-200

5.13.9 /dirreplicaipaddr (Linux and Windows only)

Specifies the IP address of an eDirectory replica for an Archive Agent that is running on a Windows server. See Changing the eDirectory Access Method for Starting the Archive Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--dirreplicaipaddr IP_address

/dirreplicaipaddr-IP_address

Example:

--dirreplicaipaddr 173.16.5.18

/dirreplicaipaddr-173.16.5.19

5.13.10 /diruseralias

Specifies the eDirectory attribute that the Archive Agent searches on for users in the Messenger client. By default, the Archive Agent searches on the CN attribute. If you use this startup switch for the Messaging Agent, as described in Customizing Authentication and Searches by eDirectory Attribute, you should use it for the Archive Agent as well, to keep searching functionality consistent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--diruseralias "eDirectory_attribute"

/diruseralias-"eDirectory_attribute"

Example:

--diruseralias "Internet EMail                                           Address"

/diruseralias-"Internet EMail                                            Address"

5.13.11 /diruserauthbind

Indicates that you want users to authenticate to eDirectory by using a bind rather than a compare operation.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--diruserauthbind

/diruserauthbind

5.13.12 /diruserforcedirect

Indicates that you want users to use direct access to eDirectory even though you have configured the Archive Agent to use LDAP access. See Using LDAP Access for the Archive Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--diruserforcedirect

/diruserforcedirect

5.13.13 /home

Specifies the distinguished name (DN) of the Archive Agent object where the Archive Agent configuration information is stored. There is no default location. You must use this switch in order to start the Messaging Agent. See Section 5.2, Starting the Archive Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--home CN=agent_object, OU=server_object, OU=Messenger_system, O=organization

/home-CN=agent_object, OU=server_object, OU=Messenger_system, O=organization

Example:

--home CN=ArchiveAgent, OU=PRV-GWSERVER, OU=MessengerService, O=Novell

/home-CN=ArchiveAgent, OU=PRV-GWSERVER, OU=MessengerService, O=Novell

IMPORTANT:Use commas, rather than periods, between object names. If any object name includes a space, surround the switch value with double quotation marks.

5.13.14 /httppassword

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--httppassword unique_password

/httppassword-unique_password

Example:

--httppassword AgentWatch

/httppassword-AgentWatch

See also /httpuser.

5.13.15 /httpport

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--httpport port_number

/httpport-port_number

Example:

--httpport 8314

/httpport-8315

5.13.16 /httpssl

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--httpssl setting

/httpssl-setting

Example:

--httpssl enable

/httpssl-enable

5.13.17 /httpuser

Specifies the user name for the Archive Agent to prompt for before allowing Archive 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 eDirectory user name because the information passes over the connection between your browser and the Archive Agent. See Using the Archive Agent Web Console and GroupWise Monitor.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--httpuser unique_username

/httpuser-unique_username

Example:

--httpuser NMWebConsole

/httpuser-NMWebConsole

See also /httppassword.

5.13.18 /ip

Binds the Archive 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 Archive Agent binds to all available IP addresses and Messenger clients can communicate with the Messaging Agent on all available IP addresses.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ip IP_address

/ip-IP_address

Example:

--ip 172.16.5.19

/ip-172.16.5.20

5.13.19 /keyfile

Specifies the full path to the private file used to provide SSL encryption between the Archive Agent and other programs. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--keyfile /dir/file

/keyfile-[drive:]\dir\file /keyfile-\\svr\sharename\dir\file

Example:

--keyfile /certs/gw.key

/keyfile-\novell\nm\ma\certs\nm.key /keyfile-m:\novell\nm\ma\certs\nm.key /keyfile-\\svr2\c\novell\nm\ma\certs\nm.key

See also /keypassword.

5.13.20 /keypassword

Specifies the password used to encrypt the private SSL key file when it was created. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--keypassword password

/keypassword-password

Example:

--keypassword gwssl

/keypassword-gwssl

See also /keyfile.

5.13.21 /language (Windows only)

Specifies the language to run the Archive Agent in, using a two-letter language code as listed below. When you install the Messenger agents, all language versions are automatically installed.

The initial default is the language used by the operating system. If that language is not available, the Archive Agent runs in English. You only need to use this switch if you need to override these defaults.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

N/A

/language-code

Example:

N/A

/language-fr

The table below lists the valid language codes:

Language

Language Code

English

EN

French

FR

German

DE

Portuguese

PT

Spanish

ES

5.13.22 /ldapipaddr

Specifies the LDAP server's network address as either an IP address or a DNS hostname. See Section 3.2, Customizing eDirectory Access for Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldapipaddr network_address

/ldapipaddr-network_address

Example:

--ldapipaddr 172.16.5.19 --ldapipaddr server1 server2

/ldapipaddr-172.16.5.20 /ldapipaddr-server1 server2

See also /ldapport.

5.13.23 /ldapport

Specifies the port number that the LDAP server listens on for service requests. The default is 389. See Providing LDAP Access to eDirectory for Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldapport port_number

/ldapport-port_number

Example:

--ldapport 391

/ldapport-392

See also /ldapipaddr.

5.13.24 /ldappwd

Provides the password for the LDAP user that the Archive Agent uses to log in to the LDAP server. See Providing LDAP Access to eDirectory for Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldappwd LDAP_password

/ldappwd-LDAP_password

Example:

--ldappwd nmldap

/ldappwd-nmldap

See also /ldapuser.

5.13.25 /ldapssl

Indicates to the Archive Agent that the LDAP server it is logging in to uses SSL encryption. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldapssl

/ldapssl

See also /ldapsslkey.

5.13.26 /ldapsslkey

Specifies the full path to the LDAP server’s root certificate. See Providing LDAP Access to eDirectory for Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldapsslkey /dir/file

/ldapsslkey-[drive:]\dir\file /ldapsslkey-\\svr\sharename\dir\file

Example:

--ldapsslkey /certs/gwkey.der

/ldapsslkey-         novell\nm\aa\certs\\nmkey.der /ldapsslkey-         m:\novell\nm\aa\certs\nmkey.der /ldapsslkey-          \\server2\c\novell\nm\                               aa\certs\nmkey.der

See also /ldapssl.

5.13.27 /ldapuser

Specifies the user name that the Archive Agent can use to log in to the LDAP server to obtain information from eDirectory. See Providing LDAP Access to eDirectory for Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ldapuser LDAP_user_ID

/ldapuser-LDAP_user_ID

Example:

--ldapuser NMAuth

/ldapuser-NMAuth

See also /ldappwd.

5.13.28 /log

Specifies the directory where the Archive Agent stores its log files. The default location is the \novell\nm\aa\log directory. See Using Archive Agent Log Files.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--log /dir

/log-[drive:]\dir /log-\\svr\sharename\dir

Example:

--log /nm/log/aa

/log-\nmlog\aa /log-m:\nmlog\aa /log-\\server2\c\mail\nmlog\aa

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

5.13.29 /logdays

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--logdays days

/logdays-days

Example:

--logdays 30

/logdays-30

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

5.13.30 /logdiskoff

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--logdiskoff

/logdiskoff

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

5.13.31 /loglevel

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--loglevel level

/loglevel-level

Example:

--loglevel diagnostic

/loglevel-diagnostic

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

5.13.32 /logmax

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--logmax megabytes

/logmax-megabytes

Example:

--logmax 256

/logmax-256

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

5.13.33 /maxconns

Specifies the maximum number of connections between the Archive Agent and Messenger clients. The default is 5120. See Optimizing Connections between the Archive Agent and Messenger Users.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--maxconns connections

/maxconns-connections

Example:

--maxconns 10000

/maxconns-10000

See also /threads.

5.13.34 /mtpipaddr

Specifies the network address of the Server where the Messaging Agent runs, as either an IP address or a DNS hostname. By default, the Archive Agent uses the network address specified on the Identification page of the Messaging Agent object.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--mtpipaddr network_address

/mtpipaddr-network_address

Example:

--mtpipaddr-172.16.5.19 --mtpipaddr server3

/mtpipaddr-172.16.5.20 /mtpipaddr-server4

See also /mtpport.

5.13.35 /mtpport

Specifies the message transfer port number on which the Archive Agent listens for conversations to archive. By default, the Archive Agent uses the message transfer port specified on the Identification page of the Archive Agent object, which is 8312.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--mtpport port_number

/mtpport-port_number

Example:

--mtpport 8413

/mtpport-8413

See also /mtpipaddr.

5.13.36 /mtpssl

Sets the availability of SSL encryption between the Archive Agent and the Messaging Agent. Valid values are enable and disable. See Section 5.6, Enhancing Archive Security with SSL Encryption.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--mtpssl setting

/mtpssl-setting

Example:

--mtpssl enable

/mtpssl-enable

5.13.37 /nomtp

Disables the Archive Agent's attempts to contact the Messaging Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--nomtp

/nomtp

5.13.38 /nosnmp

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--nosnmp

/nosnmp

5.13.39 /password

Provides the password for the Archive Agent to use when accessing eDirectory in order to obtain its configuration information from the Archive Agent object. This switch is required in order to start the Archive Agent. See Section 5.2, Starting the Archive Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--password eDirectory_password

/password-eDirectory_password

Example:

--password NMAgent

/password-NMAgent

See also /user.

5.13.40 /port

Sets the port number on which the Archive Agent listens for service requests from Messenger clients. The default is 8310. See Section 5.5, Configuring the Archive Agent in ConsoleOne.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--port port_number

/port-port_number

Example:

--port 8411

/port-8412

5.13.41 /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

Windows Messaging Agent

Syntax:

--productinfo=value

/productinfo-value

Example:

--productinfo=1

/productinfo-1

5.13.42 /queue

Specifies the directory where the Archive Agent stores conversations it receives from the Messaging Agent while it is archiving other conversations. The default is \novell\nm\aa\queue. See Moving the Archive Agent Conversation Holding Queue.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--queue /dir

/queue-[drive:]\dir /queue-\\svr\sharename\dir\

Example:

--queue /nmqueues/aa

/queue-\nmqueues\aa /queue-m:\nmqueues\aa /queue-\\server2\c\mail\nmqueues\aa

5.13.43 /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. For more information on OpenSSL format, see Cipher List Format

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--sslciphersuite “setting”

/sslciphersuite-”setting

Example:

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

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

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

5.13.44 /ssloption

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

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--ssloption SSL_protocol

/ssloption SSL_protocol

Example:

--ssloption SSL_OP_NO_TLSv1,SSL_OP_NO_TLSv1_1

/ssloption SSL_OP_NO_TLSv1,SSL_OP_NO_TLSv1_1

5.13.45 /threads

Specifies the maximum number of client/server threads the Archive Agent can create. The default is 15. See Optimizing Connections between the Archive Agent and Messenger Users.

 

Linux Archive Agent

WIndows Archive Agent

Syntax:

--threads number

/threads-number

Example:

--threads 20

/threads-20

See also /maxconns.

5.13.46 /user

Provides the eDirectory user name for the Archive Agent to use when accessing eDirectory to obtain its configuration information from the Archive Agent object. This switch is required in order to start the Messaging Agent. See Section 5.2, Starting the Archive Agent.

 

Linux Archive Agent

Windows Archive Agent

Syntax:

--user CN=User_object, OU=org_unit,O=organization

/user-CN=User_object, OU=org_unit,O=organization

Example:

--user CN=Messenger, OU=Users,O=Novell

/user-CN=Messenger, OU=Users,O=Novell

IMPORTANT:Use commas, rather than periods, between object names. If any object name includes a space, surround the switch value with double quotation marks.

See also /password.