Keywords for Tests

Service Response Monitor › Test Management › Keywords for Tests

Keywords for Tests

All SRM tests use a keyword=value format for arguments that display in the args field. Keyword-value pairs are separated by an ampersand (&) character. For example, the arguments field for a round-trip e-mail test appears similar to the following:

send_proto=smtp&to=recipient&size=256&shost=senderhost&smtp_ssl=true
&send_user=sender&send_pass=secret&get_proto=pop3&source=popserver
&source_port=110&check=600

When you use the SRM page to add or modify tests, SRM uses the correct keywords automatically. If you are editing the svcrsp.cf file manually or using svcwatch to update the file dynamically, you must use the following keywords.

Test	Keyword	Description

Active Directory	domain	The domain in which the Active Directory server is located.
	query	The query to send to the Active Directory server.
	filter	The server-side result filter.
Custom	No additional arguments
DHCP	No additional arguments
DNS	hostname	The host name to look up.
File I/O	local	The local path and file name to use for write, read/write, and compare operations.
	domain	The domain of the user logging into the server (Windows only).
	op	One of the following: r – Reads the file. w – Writes the contents of a local reference file to a test file located on a remote file system, and then deletes the test file. rw – Writes the contents of a local reference file to a test file on a remote file system, reads the test file, and then deletes it. cmp – Reads in one file and then another, and compares their contents.
FTP	local	Specifies the name of the file to be written to on the FTP Server.
	remote	Specifies the path of the file to be read.
	op	One of the following: g - (get) Log in and read the specified file (but does not perform a write operation), then log out. p - (put) Log in and write the specified file out to the FTP Server, then log out. If the remote directory does not have writer permission, the test will fail. login (no remote and local keywords) - Log in using the specified username and password and then log out.
HTTP and HTTPS	max_depth	The number of levels the test should traverse when downloading nested frames. (The HTTP and HTTPS tests download all frames, images, external scripts, and applets during the page download so that the measurement reflects the user's experience when downloading a Web page.) The default value is 3.
	proxy	The hostname of the proxy server to use if the system from which you are testing does not have direct Internet access.
	proxyuser	The user name for this proxy.
	proxypass	The password of the proxy user.
	content_dl	true - Downloads content including scripts, images, applets, and so on. false - Does not download content.
	content_err	true - Any errors while downloading cause the test to fail. false - Errors are not considered during download.
	minmatch	Minimum number of times to find the search pattern.
	search	A regular expression you want SRM to match on the pages you test.
IMAP	download	The emails to download; one of the following: Download First Message – Downloads only the first message for this user account. Download All Messages – Downloads all messages for this user account.
IMAP	delete	Whether to delete downloaded messages; one of the following: true – Deletes downloaded messages. false – Does not delete downloaded messages.
LDAP	query	Specifies the query to send to the LDAP server.
	domain	Specifies the LDAP domain.
	filter	Specifies the server-side result filter.
MAPI	domain	The Windows domain for the user account.
	op	send - Sends the test message. recv - Receives a test message.
	download	The emails to download; one of the following: Download First Message – Downloads only the first message for this user account. Download All Messages – Downloads all messages for this user account.
	to	Specifies the email recipient of the test message.
	size	Specifies the size of the test message in bytes. Default 256
	delete	Whether to delete downloaded messages; one of the following: true – Deletes downloaded messages. false – Does not delete downloaded messages.
NIS	domain	Specifies the domain on which the map file exists.
	map	Specifies the map file to test. Default: host
	download	true - Downloads the specified NIS map. false - Does not download the specified map.
File I/O	local	The local path and file name to use for write, read/write, and compare operations.
File I/O	domain	The domain of the user logging into the server (Windows only).
NNTP	No additional arguments
PING	payload	The size of the packet sent in the ping. The default packet size is 64 bytes.
POP3	download	The emails to download; one of the following: Download First Message – Downloads only the first message for this user account. Download All Messages – Downloads all messages for this user account.
POP3	delete	Whether to delete downloaded messages; one of the following: true – Deletes downloaded messages. false – Does not delete downloaded messages.
Round- Trip Email	to	The user account who receives the message.
	size	The size of the email to send in bytes. Default 256
	send_proto	The protocol to use for sending mail; one of the following: smtp mapi
	shost	Specifies the host name which sends the message.
	smtp_ssl	true - Enables SMTP SSL encryption. false - Disables SMTP SSL encryption.
	send_user	Specifies the name of the sender account.
	send_pass	Specifies the password of the sender.
	sdomain	(MAPI protocol only) The user domain for sending messages with the MAPI protocol.
	get_proto	The protocol to use for receiving mail; one of the following: pop imap mapi
	source	Specifies the host to which the email is sent.
	source_port	Specifies the port number for IMAP or POP3. Defaults: 110 (POP3), 143 (IMAP)
	gdomain	(MAPI protocol only) The user domain for retrieving messages with the MAPI protocol.
	check	Specifies the poll interval in seconds. Default: 600
	delete	Whether to delete downloaded messages; one of the following: true – Deletes downloaded messages. false – Does not delete downloaded messages.
SMTP	to	The user account to receive the email.
	size	The size of the email to send in bytes. Default: 256
	shost	Specifies the host name which sends the message.
	ssl	true - Enables SMTP SSL encryption. false - Disables SMTP SSL encryption.
SNMP	snmpversion	snmp - Specifies SNMPv1/2. snmp3 - Specifies SNMPv3.
	user	Specifies the SNMPv3 user name.
	securitylevel	Specifies the SNMPv3 security level: AuthPriv - Authentication and Privacy NoAuthNoPriv - No Authentication and no Privacy AuthNoPriv - Authentication and no Privacy
	auth_protocol	Specifies the SNMPv3 authentication protocol: MD5 SHA
	auth_password	Specifies the authentication password.
	priv_protocol	Specifies the SNMPv3 privacy protocol: DES AES 3DES
	priv_password	Specifies the privacy password.
	priv_password	Specifies the privacy password.
	oid	The object identifier of the variable to query.
	community	The community string for reading the variable.
SQL Query	query	The query to send to the database.
	qtype	(Optional) The type of the query. Valid values are: query - (Default) The query argument represents a normal query, for example, SELECT. stored - The query argument represents the argument for an EXECUTE query; a stored procedure and arguments. update - The query argument contains an update query, For example, INSERT. This query type returns an integer value: -1, 0, positive integer
	dbtype	Specifies the type of the database: oracle mssql other
	driver	(for 'other' databases) The JDBC driver to use for the query.
	url	(for 'other' databases) The database connect string; varies by database type. For information about connect strings, refer to your database documentation.
	dbname	The name of the database to query. When using "other" as database type, this field does not appear in the user interface. Specify the database name in the connect string instead.
TCP Connect	No additional arguments
TFTP	path	The path and file name of the file to read or write.
TFTP	op	One of the following: r – Reads a file from the server. w – Writes a file to a remote file system.
Virtual User	domain	The domain for the user who is running the script.
	port	The port on which the script is running.
	hostname	The hostname of the destination system; this value is used for DNS lookup and connection timings.
	hostname