Sun Java System Messaging Server 6 2005Q4 Administration Reference

Options

The following list contains valid task options for the command.

Option  

Description  

-u user_name

The valid test user account to use. This test mail user has to be created by the administrator. If the test mail user is in a hosted domain, user@domain should be specified.

-w passwd

The password corresponding to the user specified with -u. This option is mandatory when the -I or -P is used. “-” can specified with -w, to enter the password through standard input.

-L LDAP_host: [ port ] = [ threshold ]

Use the LDAP server and the port specified to check the Directory Server. The threshold is specified in seconds. 

-I IMAP_host: [ port ] = [ threshold ]

Use the IMAP server and the port specified to check the IMAP component of the Message Access. The threshold is specified in seconds. The threshold involves the time to login, retrieve, and delete the message. 

-P POP_host: [ port ] = [ threshold ]

Use the POP server and the port specified to check the POP component of the Message Access. The threshold is specified in seconds. The threshold involves the time to login, retrieve, and delete the message. 

-S SMTP_host: [ port ] = [ threshold ]

Use the SMTP server and the port specified to check if Messaging Server is able to accept mail for delivery. The threshold is specified in seconds. 

-C LMTP_host: [ port ] = [ threshold ]

Use the LMTP server and the port specified to check if Messaging Server is able to deliver the message to the store. The threshold is specified in seconds. 

-H HTTP_host: [port] = [ threshold ]

Use the HTTP server and the port specified to check if the HTTP server is able to accept requests on the specified port. When -I -H or -P is used, it is necessary to provide the test user password with -w. When -S/-C, -I/-P are specified together, the command does the following:

- sends mail and retrieves with IMAP and POP 

- reports the per protocol response time 

- reports round-trip time o reports delivery time (the time taken to send the mail and be visible to IMAP/POP) 

Multiple -I, -P, and -S options can be specified, which helps in monitoring Messaging Server on various systems.

-b searchbase

Use search base as the starting point for the searching in the Directory Server. It is the same as -b of ldap-search(1). If -b is not specified, the utility uses the value of dcRoot of the configuration parameter local.ugldapbasedn.

-f mail From option:

When immonitor-access sends out an e-mail, it usually is sent as root@domainname. Specify this option to send out an e-mail as different user: -f user@red.iplanet.com

-D threshold

The delivery (also called round-trip time) threshold. The time taken to send the mail and the mail being visible to POP/IMAP. This option can be used only when -I/-P and -S/-C are used.

-h

Prints command usage syntax. 

-i inputfile

Read the command information from a file instead of from the command line. 

-m file

The file that is mailed to the test user. You can get response and round-trip times for various mail sizes with this option. Specify only text files as non-text files result in unexpected behavior. If -m is not specified, the mailfile.txt file in msg_svr_base/lib/locale/C/mailfile.txt is used as the mail file.

-k subject

Header subject of the messages to be sent/deleted. The utility, by default, uses the string “immonitor:<date>” as the subject in the header sent out with the -S option. If -k is specified, the string “immonitor:subject” is used in the subject header.

This option can be used with -z to delete messages, if -k is not specified, all messages with the Subject header containing “immonitor” are deleted.

-z

Delete messages containing the string specified by -k in the subject header. If -k is not specified, all messages with the subject header containing “immonitor” are deleted. Use -z only with -I or -P. Do note use -z with -S or -C as this can cause unexpected results.

-r alert_recipients

A comma-separated list of mail recipients who will be notified. If this option is not specified, the command reports the alert messages on the standard output. 

-A host

The alternate mail server to be used to send mail to the alert_recipients. This option helps in sending alert messages even when the primary mail server is down or heavily loaded. If -A is not specified, the SMTP server on the localhost is used.

-h

Display the usage message. 

-d

The debug mode: display the execution steps. 

-v

Run in verbose mode, with diagnostics written to standard output. 

The default ports are:

SMTP = 25IMAP = 143POP = 110 LDAP = 389LMTP = 225HTTP = 80

If either the port or threshold is not specified, default ports with the default threshold of 60 seconds is assumed. The threshold specified can be a decimal number.