Previous Topic: svcwatch add ping Command--Add a PING Test

Next Topic: svcwatch add rtemail Command--Add a Round Trip Email Test

Service Response Monitor › Service Response Monitor CLI Commands › svcwatch add pop3 Command--Add a POP3 Test

svcwatch add pop3 Command--Add a POP3 Test

The svcwatch add pop3 command adds a POP3 test to SRM on the specified host.

This command has the following format:

svcwatch [options] -o add index descr pop3 destination 
username password args interval samples timeout winsiz tos 
limit flags name class contextInfo logLevel

The add command uses the following parameters:

options

Specifies the possible options for this command.

-h hostname | -h ipAddr

(Optional) Specifies the SystemEDGE host.

Default: localhost

-p port

(Optional) Specifies the SystemEDGE SNMP port.

Default: 161

-c community

(Optional) Specifies the SNMP community string for SNMP version 1 and 2c.

Default: public

-v snmpVersion

(Optional) Specifies the SNMP version. Possible values are:

  • 1
  • 2c
  • 3

Default: 1

-u secName

(Optional) Specifies the name of the SNMPv3 secure user.

-u secLevel

(Optional) Specifies the level of security for SNMPv3. Possible values are:

  • 1 – noAuthNoPriv
  • 2 – AuthNoPriv
  • 3 – AuthPriv
-n contextName

(Optional) Specifies the instance name for a MIBMuxed agent.

-a authPassword

(Optional) Identifies the authentication password required when SNMPv3 is selected with security AuthNoPriv or AuthPriv.

-A authProtocol

(Optional) Specifies the authentication protocol. Possible values are:

  • MD5 – authentication protocol HMAC-MD5
  • SHA – authentication protocol HMAC-SHA

Default: MD5

-x privPassword

(Optional) Specifies the privacy (encryption) password for SNMPv3 with security level 3 (AuthPriv).

-X encryptProtocol

(Optional) Specifies the use of encryption protocol for privacy. Possible values are:

  • DES – Data Encryption Standard
  • AES – Advanced Encryption Standard using cryptographic keys of 128 bits (AES128)
  • 3DES – Triple Data Encryption Standard
-m FIPSmode

(Optional) Specifies the FIPS mode. Possible values are:

  • 0 – non-FIPS
  • 1 – FIPS coexistence
  • 2 – FIPS only

Default: 0

-t timeout

(Optional) Specifies the SNMP command timeout.

Default: 10 seconds

-d logLevel

(Optional) Specifies the log level for SNMP messages. Possible values are:

  • 0 – log fatal messages
  • 1 – log critical messages
  • 2 – log warning messages
  • 3 – log information messages
  • 4 – log all messages
  • 5 – log all messages including debugging messages

Default: 0

-f logFile

(Optional) Specifies the name of the logfile.

Default: sysedge_utility.log

-L

(Optional) Detects the current locale of the console and language catalog if available. If a language catalog is not found, the utility falls back to English as a default language.

-o add testparams

Adds a new test to SRM.

testparams

Specifies the parameters for the new test.

index

Specifies the svcRspTable index.

descr

Specifies the description of the test in quotes. An empty string in quotes "" specifies no description.

pop3

Specifies the POP3 service type.

destination

Specifies the POP3 server and port (server:port) for the test. Default port: 110

username

Specifies the user name for authentication in quotes. An empty string in quotes "" specifies no user name.

password

Specifies the password for authentication in quotes. An empty string in quotes "" specifies no password.

args

Specifies the service arguments. Each argument is a pair of a keyword and a value (key=value). Multiple arguments are concatenated and delimited by ampersands (&). The complete arguments string is enclosed in quotes.

General syntax for arguments: "key1=value1[&key2=value2& ...]"

download=Download First Message - Downloads only the first message for this user account.

download=Download All Messages - Downloads all messages for this user account.

delete=true - Deletes downloaded messages.

delete=false - Does not delete downloaded messages.

Note: For details of the particular arguments for each service type, see Keywords for Tests.

interval

Specifies the test interval in seconds.

Limits: multiple of 30 seconds

samples

Specifies the samples per interval.

timeout

Specifies the timeout in seconds.

winsiz

Specifies the statistics window size in seconds.

tos

Specifies the IP Type of Service or Differentiated Services Code. Use 0 (zero) for a normal service. See also RFC 1349.

limit

Specifies the acceptable performance limit (or threshold) for the total response time of this test. This value is used in reports.

flags

Specifies the following flags:

0x001 = collect performance cubes

0x100 = execute on request only (run once)

name

Specifies the unique name per service type. An empty string in quotes "" specifies no test name.

class

Specifies the class name. An empty string in quotes "" specifies no class name.

contextInfo

Specifies context information. An empty string in quotes "" specifies no context information.

logLevel

Specifies the log level for the test execution code. Possible values are:

-2 = use SRM-global log level (default)

-1 = do not log

0 = fatal (only the most important messages)

1 = critical

...

7 = debug3 (log all messages)

Example

Adding a POP3 test:

svcwatch -h localhost -p 161 -c doublesecret -o add 1360753 "POP3-TEST" 
pop3 "mypop3server:110" "pop3user" "pop3pass" "download=Download First Message
&delete=true" 30 3 30 60 0 0 0x100 "TestPOP3" "ClassName" "ContextName" 7

More Information

Keywords for Tests