User Guide for Cisco Unified Operations Manager 2.0
Using Batch Tests
Download this chapter
Using Batch TestsUsing Batch Tests
Download the complete book
User Guide for Cisco Unified Operations ManagerUser Guide for Cisco Unified Operations Manager (PDF - 9 MB)
give_us_feedback

Table Of Contents

Using Batch Tests

Working with Batch Tests

Creating Batch Tests

Formatting Batch Test Import Files

Editing Batch Tests

Deleting a Batch Test

Viewing Batch Test Details

Verifying the Status of a Test

Suspending/Resuming a Batch Test

Scheduling a Batch Test to Run

Running a Batch Test on Demand

Viewing Batch Test Results

Printing Batch Test Results

Exporting Batch Test Results

Understanding Phone Tests

Where Is Batch Test Data Stored?


Using Batch Tests

Note If you do not have the required software license, you will not be able to use batch tests.

Batch tests enable you to test the health and connectivity of a branch office. Batch tests consist of a set of synthetic tests (see Using Synthetic Tests) that are run on voice applications (for example, Cisco Unified CallManager Express or Cisco Unity Express) that are deployed in a branch office and a set of phone tests (see Understanding Phone Tests) that are run on real phones in the branch office. Batch tests can be run once a day to verify the health of the voice network in the branch office.

The following topics are covered:

•Working with Batch Tests

•Viewing Batch Test Results

•Understanding Phone Tests

Working with Batch Tests

This section describes how to create, edit, remove, and analyze batch tests in Operations Manager, as well as how to stop or start batch test operations.

This section includes the following topics:

•Creating Batch Tests

•Editing Batch Tests

•Deleting a Batch Test

•Viewing Batch Test Details

•Verifying the Status of a Test

•Suspending/Resuming a Batch Test

•Scheduling a Batch Test to Run

Creating Batch Tests

You create batch tests by importing them using a comma separated values (CSV) file. Each individual batch test consists of multiple synthetic tests and phone tests.

Note In a single batch test, do not create phone tests that include both Cisco Unified CallManager 4.x and Cisco Unified CallManager 5.x. You can create a single batch test that includes different versions of Cisco Unified CallManager 4.x, or a single batch test that includes different versions of Cisco Unified CallManager 5.x, but do not combine 4.x with 5.x.

Before You Begin

•Verify that your seed file is formatted correctly. For details, see Formatting Batch Test Import Files.

•Place the seed file on the server, in the NMSROOT\ImportFiles directory. If you do not have access to the directory, contact a local administrator for the server where Operations Manager is installed.

Note NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Note If you do not have the required software license, you will not be able to use batch tests. The Diagnostic tab will not appear in Operations Manager.

Step 2 Click Create. The Create Batch Test page appears.

Step 3 Enter the name of the seed file in the Filename field and click OK.

Formatting Batch Test Import Files

The batch test import file is an XML file. You can find an example of an import file in the <NMSROOT>\Importfiles folder.

Note NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.

A batch test import file contains information for one batch test. Each batch test import file contains all the information required to configure the synthetic tests and phone tests for that particular batch test.

•For specific details on what information is required to configure synthetic tests, see Configuring Synthetic Tests.

•For specific details on what information is required to configure phone tests, see Understanding Phone Tests.

When creating a batch test import file, observe the following guidelines for the listed fields:

•TestSchedule—Can have multiple schedule entries.

•Each ScheduleEntry—Must have the following five fields:

–Month—Not supported.

–DayOfMonth—Not supported.

–DayOfWeek—Must be 0 through 6 or asterisk to indicate all days.

–Hour—Must be between 0 and 23.

–Minute—Must be between 0 and 59.

•CallAgent—Can be a Cisco Unified CallManager or a Cisco Unified CallManager Express.

•PhoneMACAddress—The MAC address of a synthetic phone. It must be in the range of 00059A3B7700 to 00059A3B8AFF.

•PhoneProtocol—The protocol of the synthetic phone, either SCCP or SIP.

•PhoneURIorExtension—The extension or URI of a SIP phone. This is ignored for SCCP phones.

•OnsiteAlertNumber—Required only when IsOSANEnabled is set to true.

Example Batch Test Import FIle 

<BatchTest name="batch-test1" xsi:noNamespaceSchemaLocation="BatchTest.xsd">

-

		<TestSchedule>

-

	<ScheduleEntry>

<month>*</month>

<dayOfMonth>*</dayOfMonth>

<dayOfWeek>*</dayOfWeek>

<hour>10</hour>

<minute>10</minute>

</ScheduleEntry>

-

	<ScheduleEntry>

<month>*</month>

<dayOfMonth>*</dayOfMonth>

<dayOfWeek>*</dayOfWeek>

<hour>20</hour>

<minute>20</minute>

</ScheduleEntry>

</TestSchedule>

<CiscoCallManager name="CM1" address="ipif-ccm1.cisco.com" jtapiUsername="jtuser" 
jtapiPassword="cisco"/>

<CiscoCallManager name="CM2" address="ipif-skate.cisco.com" jtapiUsername="jtuser" 
jtapiPassword="cisco"/>

-

	<PhoneRegistrationTest name="skinny-reg">

-

	<Phone>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7700</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Phone>

<SuccessCriteria>RegistrationFailure</SuccessCriteria>

</PhoneRegistrationTest>

-

	<PhoneRegistrationTest name="sip-reg">

-

	<Phone>

<CallAgent>ipcom-sd1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7800</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7800@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Phone>

<SuccessCriteria>RegistrationSuccess</SuccessCriteria>

</PhoneRegistrationTest>

-

	<DialToneTest name="dial-tone">

-

	<Phone>

<CallAgent>ipcom-sd1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7701</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Phone>

</DialToneTest>

-

	<TftpTest name="tftp-download">

<TftpServer>ipif-skate.cisco.com</TftpServer>

</TftpTest>

-

	<EndToEndTest name="e2e-skinny2real">

-

	<Caller>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7704</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

<IsDestRealPhone>true</IsDestRealPhone>

<ReceiverURIorExtension>5555</ReceiverURIorExtension>

<WaitForAnswer>true</WaitForAnswer>

<EnableRTPTransmission>false</EnableRTPTransmission>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</EndToEndTest>

-

	<EndToEndTest name="e2e-sip2real">

-

	<Caller>

<CallAgent>ipcom-sd1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7801</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7801@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Caller>

<IsDestRealPhone>true</IsDestRealPhone>

<ReceiverURIorExtension>5555</ReceiverURIorExtension>

<WaitForAnswer>true</WaitForAnswer>

<EnableRTPTransmission>false</EnableRTPTransmission>

<SuccessCriteria>CallFailure</SuccessCriteria>

</EndToEndTest>

-

	<EndToEndTest name="e2e-skinny2skinny">

-

	<Caller>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7702</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

<IsDestRealPhone>false</IsDestRealPhone>

-

	<Receiver>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7703</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Receiver>

<ReceiverURIorExtension>7703</ReceiverURIorExtension>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</EndToEndTest>

-

	<EndToEndTest name="e2e-sip2sip">

-

	<Caller>

<CallAgent>ipcom-sd1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7800</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7800@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Caller>

<IsDestRealPhone>false</IsDestRealPhone>

-

	<Receiver>

<CallAgent>ipcom-sd1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7801</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7801@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Receiver>

<ReceiverURIorExtension>sip:7801@ipif-ccm1.cisco.com</ReceiverURIorExtension>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</EndToEndTest>

-

	<EndToEndTest name="e2e-skinny2sip">

-

	<Caller>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7705</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

<IsDestRealPhone>false</IsDestRealPhone>

-

	<Receiver>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7802</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7802@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Receiver>

<ReceiverURIorExtension>6666</ReceiverURIorExtension>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</EndToEndTest>

-

	<EndToEndTest name="e2e-sip2skinny">

-

	<Caller>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7803</PhoneMACAddress>

<PhoneProtocol>SIP</PhoneProtocol>

<PhoneURIorExtension>sip:7803@ipcom-sd1.cisco.com</PhoneURIorExtension>

</Caller>

<IsDestRealPhone>false</IsDestRealPhone>

-

	<Receiver>

<CallAgent>10.76.93.118</CallAgent>

<PhoneMACAddress>00059A3B7706</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Receiver>

<ReceiverURIorExtension>6666</ReceiverURIorExtension>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</EndToEndTest>

-

	<MWITest name="unity-mwi">

<VoiceMailSystem>10.76.91.175</VoiceMailSystem>

-

	<Caller>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7707</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

-

	<Receiver>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7708</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Receiver>

<ReceiverExtension>4000</ReceiverExtension>

<VoiceMailPassword>123456</VoiceMailPassword>

</MWITest>

-

	<ConferenceTest name="ccc">

<ConferenceServer>10.76.91.151</ConferenceServer>

-

	<FirstParticipant>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7709</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</FirstParticipant>

-

	<SecondParticipant>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7710</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</SecondParticipant>

<UserName>cccUser</UserName>

<Password>cisco</Password>

<MeetingId>444444</MeetingId>

<ConferenceDialIn>1234</ConferenceDialIn>

</ConferenceTest>

-

	<EmergencyCallTest name="cer">

<EmergencyCallRouter>10.76.91.149</EmergencyCallRouter>

-

	<Caller>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7711</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

-

	<PublicSafetyAnsweringPoint>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7712</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</PublicSafetyAnsweringPoint>

<EmergencyNumber>911</EmergencyNumber>

<IsOSANEnabled>false</IsOSANEnabled>

</EmergencyCallTest>

-

	<EmergencyCallTest name="cer-with-osan">

<EmergencyCallRouter>10.76.91.149</EmergencyCallRouter>

-

	<Caller>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7711</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</Caller>

-

	<PublicSafetyAnsweringPoint>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7712</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</PublicSafetyAnsweringPoint>

<EmergencyNumber>911</EmergencyNumber>

-

<IsOSANEnabled>true</IsOSANEnabled>

-

	<OnSiteAlertNumber>

<CallAgent>ipif-ccm1.cisco.com</CallAgent>

<PhoneMACAddress>00059A3B7713</PhoneMACAddress>

<PhoneProtocol>SCCP</PhoneProtocol>

<PhoneURIorExtension/>

</OnSiteAlertNumber>

</EmergencyCallTest>

-

	<PhoneTest name="pt1" primaryCallManager="CM1">

<TestPhones>3333,4444,5555,6666</TestPhones>

<TestProbes>1111,1112,1113,1114</TestProbes>

-

	<Action name="IntraClusterCall" type="Call">

<Destination>5555</Destination>

<DestinationCallManager>ipif-ccm1.cisco.com</DestinationCallManager>

</Action>

-

	<Action name="CallToPSTN" type="Call">

<Destination>918041036116</Destination>

</Action>

-

	<Action name="Call to PSTN Negative" type="Call">

<Destination>918041036116</Destination>

<SuccessCriteria>CallFailure</SuccessCriteria>

</Action>

-

	<Action name="Inter Cluster Call" type="Call">

<Destination>5555</Destination>

<DestinationCallManager>ipif-ccm1.cisco.com</DestinationCallManager>

</Action>

<Action name="Call Hold test" type="CallHold"/>

<Action name="Call Forward test" type="CallForward"/>

<Action name="Call Park test" type="CallPark"/>

<Action name="Conference test" type="Conference"/>

</PhoneTest>

-

	<PhoneTest name="pt2" primaryCallManager="CM2">

<TestPhones>3333,4444,5555,6666</TestPhones>

<TestProbes>1111,1112,1113,1114</TestProbes>

-

	<Action name="Call to PSTN Negative" type="Call">

<Destination>918041036116</Destination>

<SuccessCriteria>CallSuccess</SuccessCriteria>

</Action>

-

	<Action name="Inter Cluster Call" type="Call">

<Destination>5555</Destination>

<DestinationCallManager>ipif-ccm1.cisco.com</DestinationCallManager>

<SuccessCriteria>CallFailure</SuccessCriteria>

</Action>

<Action name="Call Hold test" type="CallHold"/>

<Action name="Call Forward test" type="CallForward"/>

</PhoneTest>

</BatchTest>

Editing Batch Tests

You can change an existing batch test by importing a new batch test import file. The previous batch test information is overwritten by the new import file. To change the import file, you must manually edit the file (see Formatting Batch Test Import Files).

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 Select the batch test that you want to change.

Step 3 Click Edit. The Edit Batch Test page appears.

Step 4 Enter the name of the seed file in the Filename field and click OK.

Deleting a Batch Test

You can use this function to delete one or more tests. You can delete tests in any state. See Table 11-1 for a description of possible states.

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 Select the tests you want to delete, and then click Delete. A confirmation dialog box appears.

Step 3 Click Yes. Operations Manager deletes the tests you selected.

Viewing Batch Test Details

You can find all the details about a particular batch test on the Test Details page.

As with any of the reports in Operations Manager, you can print the report or export it to a file (see Printing Batch Test Results and Exporting Batch Test Results).

The Test Details page lists all the synthetic tests and phone tests that are part of the batch test.

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 Select the test you want to view, and click View. The Test Details page opens.

Note You can jump to any of the tests listed in the Test Details page by selecting the test from the Go to Test menu at the top of the page.

The page contains the following information:

•Test summary:

–Test name—Name of the batch test.

–Test details—The number of synthetic and phone tests configured.

–Test schedule.

•Synthetic tests:

–Test name—Name of the synthetic test.

–Test type—Type of synthetic test (see Using Synthetic Tests).

–Phone details—Call Agent, MAC Address, Protocol, and URI/Extension. The phone information is provided for all phones, whether it is the calling or receiving phone.

•Phone tests:

–Test name—Name of the phone test.

–Primary Cisco Unified CallManager.

–Test phones.

–Test probes.

–Phone action details—Lists the actions that the phone tests performed.

Note For descriptions of the phone tests, see Understanding Phone Tests.

Verifying the Status of a Test

You can verify whether a test ran and completed correctly. You can also troubleshoot the test if necessary.

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears. All current batch tests appear on the page. The last column in the table shows the status of each test.

Table 11-1 Test Status Definitions

Test Status
Description

Running

The test is active and collecting data.

Suspended

The test is suspended from data collecting or polling. This occurs because the device was suspended.

Scheduled

Appears after you create or update a test. The status will change to Running at the first polling cycle.


Suspending/Resuming a Batch Test

When you suspend a batch test it no longer runs at its scheduled time. The test is not removed from the system. If you want to remove the test, it must be deleted (see Deleting a Batch Test).

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 If the batch test is active and you want to stop it from running, click Suspend.

Step 3 If the batch test is suspended and you want it to run it at its scheduled time, click Resume.

Scheduling a Batch Test to Run

The scheduled time and day that a batch test is to run is configured in the import file (see Formatting Batch Test Import Files). But if you want to run a batch test on demand, you can use the Run Now button.

Running a Batch Test on Demand

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 Select the batch test that you want to run.

Step 3 Click Run Now. The batch test runs.

Viewing Batch Test Results

No events or alerts are generated when a component of a batch test fails. You must use the Batch Test Results report to see the results of a batch test. A new Batch Test Results report is generated every 24 hours for each batch test.

As with any of the reports in Operations Manager, you can print the report or export it to a file (see Verifying the Status of a Test and Exporting Batch Test Results).

The Batch Test Results report provides the following information for the overall batch test:

•Test status.

•The date and time that the test started and finished.

The Batch Test Results report provides the following information for the individual tests that are a part of the batch test:

•Test type.

•Whether or not it is a negative test.

•Test status (passed or failed).

•The date and time that the test finished.

•Any error messages.

Step 1 Select Diagnostics > Batch Tests. The Batch Tests page appears.

Step 2 Select the batch test that you want to see the results for.

Step 3 Click Results. The Batch Test Results report appears.

Printing Batch Test Results

Step 1 In a batch test report, click the printer icon in the upper-right corner of the window.

The records are reformatted into a print-friendly format and are displayed in a new browser window.

Step 2 Use the print function on your browser to print the display.

Exporting Batch Test Results

Step 1 In a batch test report, click the export icon in the upper-right corner of the window. Select either CSV or PDF format for export and click OK.

Step 2 If you chose CSV in Step 1, do the following:

a. When the File Download dialog box appears, click Save.

b. In the Windows folder window, enter the filename and the location where you want to save the file.

c. Click Save.

d. In the Download Complete dialog box, click Close.

Step 3 If you chose PDF in Step 1, do the following:

a. If a security information dialog box appears, click Yes. The records now appear in PDF format.

b. Use the PDF save function to save the file to your system.

Understanding Phone Tests

The phone tests that are run as part of batch testing take control of a real phone in the network and make a call from that phone to another phone. Phone tests use JTAPI credentials. These credentials must be included in the batch test import file.

Note In a single batch test, do not create phone tests that include both Cisco Unified CallManager 4.x and Cisco Unified CallManager 5.x. You can create a single batch test that includes different versions of Cisco Unified CallManager 4.x, or a single batch test that includes different versions of Cisco Unified CallManager 5.x, but do not combine 4.x with 5.x.

Table 11-2 describes the different phone tests that are used in batch testing.

Note Do not confuse these phone tests with other Operations Manager phone tests (synthetic tests or phone status tests). These phone tests are part of batch testing only.

Table 11-2 Phone Test Descriptions—Batch Tests

Test
Description

Call

Takes control of a phone and places a call to a given number. The call can be from a real phone to a number, in which case the test is controlling the caller only. Alternatively, the call can be from a real phone to a real phone, in which case the test is controlling both the caller and the receiver.

Call Hold

Takes control of two phones and performs the following:

•Places a call from phone A to phone B.

•Has phone B put the call on hold.

•Disconnects the call.

Call Forward

Takes control of three phones and performs the following:

•Places a call from phone A to phone B.

•Forwards the call to phone C from phone B.

•Verifies that the call is received by phone C.

•Disconnects the call.

Call Park

Takes control of three phones and performs the following:

•Places a call from phone A to phone B.

•Has phone B park the call. The call disappears from phone B and a message is displayed to tell you where the call is parked (for example, Call Park at 80503).

•Has phone C dial the number where the call is parked. The parked call is transferred to the phone that you made the call from.

•Disconnects the call.

Call Transfer

Takes control of three phones and performs the following:

•Places a call from phone A to phone B.

•Has phone B transfer the call to phone C.

•Has phone C accept the call.

•Disconnects the call.

Conference

Takes control of three phones and performs the following:

•Places a call from phone A to phone B.

•Places a conference call from phone A to phone C.

•Disconnects the call.


Where Is Batch Test Data Stored?

Operations Manager saves the data collected by the batch tests to disk. Batch test data is stored on the Operations Manager server in the NMSROOT\data\bt folder.

Note NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it is C:\Program Files\CSCOpx.