Configuration › Edit the Control File › Test Definition Parameters Block

Test Definition Parameters Block

The test definition parameters block in the configuration file provides the following parameters:

type=testtype

Specifies the test type. For example HTTP, FTP, LDAP, and so on. See the chapter Test Management in this guide for a complete list of test types.

index=integer

Specifies a unique number to identify the test. This number is the index of the corresponding service response time table entry.

name=string

(Optional) Specifies a test instance name for the test, used for state manager object information, resource instance information for performance data collection, and as an alternative to the random integer index as a primary key for tests (which can change depending upon the templates delivered). This value is only written during creation of the test.

class=string

(Optional) Specifies a class name for the test, used for state manager object information, resource instance information for performance data collection, and as an alternative to the random integer index as a primary key for tests (which can change depending upon the templates delivered). This value is only written during creation of the test.

context=string

(Optional) Specifies a holder for whatever the manager configuring the test would want to specify. This can be seen as a location to store any information a given manager would like to store, such as UUIDs, flags, antecedents for this test object, and so on. SRM does not directly use this information for any functionality, but delivers this information as part of any manager notification.

desc=string

(Optional) Specifies a meaningful description of the test.

Limits: 4096 characters

dest=string

Specifies the target of the test. For example, URL, server name, script, and so on.

user=string

Specifies the user name if the test requires a login to run the test.

pass=string

Specifies the password if the test requires a login to run the test. The password is encrypted by default. In this case, bit 4 of svcRspSecurityFlags is set to 1. If the password is unencrypted, bit 4 of svcRspSecurityFlags is set to 0.

args=string

(Optional) Specifies service-specific arguments used for measuring purposes.

Limits: 256 characters

Example service arguments are:

dns: dns-server hostname

http: URL [proxy-server] [username:user password:pass]

https: URL [proxy-server] [username:user password:pass]

ftp: ftp-server username passwd

pop3: pop3-server username passwd

nntp: nntp-server

smtp: smtp-server

ping: system-name packetsize

tcpconnect: system-name port

custom: not used

encoded={yes | no}

Specifies password encryption. If set to “no” SRM will encrypt the password and change this value to “yes”.

interval=integer

(Optional) Specifies the time interval between queries to the service.

Default: 60

samples=integer

(Optional) Specifies the number of samples taken at each query interval. For example, if this value is set to three and interval=60, then SRM performs after every 60 second interval three sample transactions.

Default: 1

timeout=integer

(Optional) Specifies the value (in seconds) after which service response time measurement shall timeout for this particular service measurement.

Default: 10

window=integer

(Optional) Specifies the period (in seconds) over which response time statisics (mean, availability, and so on) for the particular service are calculated.

Default: 300

tos=integer

(Optional) Specifies a 8-bit TOS header in the IP header for each test (IP Type of Service or Differentiated Services Code). The parameter does not enforce any particular RFC standard for the value of this field. It is up to you to decide an appropriate value.

Default: 0

limit=integer

(Optional) Specifies the response limit, used as a boundry for throwing exceptions.

Default: 0

monitor=monName, mon_index

(Optional) Specifies the associated monitoring template (threshold) for that test.

The monName variable is equal to the monName parameter value of the monitoring template. The monIndex variable is a unique value for the table entry and the index of the monitor in SystemEDGE’s monitor table.

status={active | notInService}

(Optional) Specifies the status of this entry. This variable is equivalent in semantics to the SNMPv2 SMI RowStatus convention (see RFC 1443).

active(1): Available for usage.

notInService(2): Disables usage of the row.

Default: notInService

flags=hex_value

(Optional) Test configuration flags:

0x0001 [cube_collect]: Enables the collection of test metrics for this test.

0x0100 [run_once]: Specifies that this test is only to be run on request, not through the poll interval scheduler.

Default: 0x0

loglevel={-1 | 0 | 1 | 2 | ... | 7}

(Optional) Specifies the log level for the SRM AIM. See also Global Parameters Block.

-1: Logs no messages

0: Logs fatal level messages

1: Logs also critical level messages

2: Logs also warning level messages

3: Logs also information level messages

4: Logs also debug level messages

5: Logs also debug1 level messages

6: Logs also debug2 level messages

7: Logs also debug3 level messages

Default: global log level

Example

{
  index=25
  type=http
  desc="www.ca.com Http"
  dest="http://www.ca.com"
  encoded="yes"
  password=""
  args="max_depth=3&content_dl=yes&content_err=no"
  interval=30
  samples=1
  timeout=20
  window=300
  tos=0
  limit=0
  status=active
  name="www.ca.com-http"
  class=""
  context=""
  loglevel=1
  flags="1"
  monitor=TotalMeanCritical9000,2511
  monitor=TotalMeanWarning5000,2510
}
{
  type=monitor
  monName="TotalMeanCritical9000"
  monSeverity=critical
  monAttribute=svcRspTableTotalMean
  monThreshold=9000
  monOperator=gt 
}
{
  type=monitor
  monName="TotalMeanWarning5000"
  monSeverity=warning
  monAttribute=svcRspTableTotalMean
  monThreshold=5000
  monOperator=gt
}