Hawkeye Advance Admin Guide

Hawkeye
User Guide
Release 3.1
913-2383-01 Rev A
acquires commercial computer software
Notices under the same terms by which the
software is customarily provided to the
Copyright Notice public. Accordingly, Keysight provides the
© Keysight Technologies 2019 Software to U.S. government customers
under its standard commercial license,
No part of this document may be
which is embodied in its End User License
reproduced in any form or by any means
Agreement (EULA), a copy of which can
(including electronic storage and retrieval
be found at
or translation into a foreign language)
http://www.keysight.com/find/sweula or
without prior agreement and written
https://support.ixiacom.com/support-
consent from Keysight Technologies, Inc.
services/warranty-license-agreements.
as governed by United States and
The license set forth in the EULA
international copyright laws.
represents the exclusive authority by
which the U.S. government may use,
Warranty modify, distribute, or disclose the
The material contained in this document Software. The EULA and the license set
is provided “as is,” and is subject to being forth therein, does not require or permit,
changed, without notice, in future among other things, that Keysight: (1)
editions. Further, to the maximum extent Furnish technical information related to
permitted by applicable law, Keysight commercial computer software or
disclaims all warranties, either express or commercial computer software
implied, with regard to this manual and documentation that is not customarily
any information contained herein, provided to the public; or (2) Relinquish
including but not limited to the implied to, or otherwise provide, the government
warranties of merchantability and fitness rights in excess of these rights
for a particular purpose. Keysight shall not customarily provided to the public to use,
be liable for errors or for incidental or modify, reproduce, release, perform,
consequential damages in connection display, or disclose commercial computer
with the furnishing, use, or performance software or commercial computer
of this document or of any information software documentation. No additional
contained herein. Should Keysight and the government requirements beyond those
user have a separate written agreement set forth in the EULA shall apply, except to
with warranty terms covering the the extent that those terms, rights, or
material in this document that conflict licenses are explicitly required from all
with these terms, the warranty terms in providers of commercial computer
the separate agreement shall control. software pursuant to the FAR and the
DFARS and are set forth specifically in
Technology Licenses writing elsewhere in the EULA. Keysight
The hardware and/or software described shall be under no obligation to update,
in this document are furnished under a revise or otherwise modify the Software.
license and may be used or copied only in With respect to any technical data as
accordance with the terms of such defined by FAR 2.101, pursuant to FAR
license. 12.211 and 27.404.2 and DFARS 227.7102,
the U.S. government acquires no greater
U.S. Government Rights than Limited Rights as defined in FAR
27.401 or DFAR 227.7103-5 (c), as
The Software is "commercial computer
applicable in any technical data. 52.227-
software," as defined by Federal
14 (June 1987) or DFAR 252.227-7015 (b)
Acquisition Regulation ("FAR") 2.101.
(2) (November 1995), as applicable in any
Pursuant to FAR 12.212 and 27.405-3 and
technical data.
Department of Defense FAR Supplement
("DFARS") 227.7202, the U.S. government
– ii – 913-2383-01 Rev A
Contact Us
Ixia headquarters
26601 West Agoura Road
Calabasas, California 91302
+1 877 367 4942 – Toll-free North America
+1 818 871 1800 – Outside North America
+1.818.871.1805 – Fax
www.ixiacom.com/contact/info
Support
Global Support +1 818 595 2599 support@ixiacom.com
Regional and local support contacts:
APAC Support +91 80 4939 6410 support@ixiacom.com
Australia +61-742434942 support@ixiacom.com
EMEA Support +40 21 301 5699 support-emea@ixiacom.com
Greater China Region +400 898 0598 support-china@ixiacom.com
Hong Kong +852-30084465 support@ixiacom.com
India Office +91 80 4939 6410 support-india@ixiacom.com
Japan Head Office +81 3 5326 1980 support-japan@ixiacom.com
Korea Office +82 2 3461 0095 support-korea@ixiacom.com
Singapore Office +65-6215-7700 support@ixiacom.com
Taiwan (local toll-free number) 00801856991 support@ixiacom.com
– iii – 913-2383-01 Rev A

Documentation conventions
Documentation conventions
The following documentation conventions are used in this guide:
Describing interactions with the UI

You can interact with products by using different input methods: keyboard, mouse, touch, and more.
So in most parts of the user documentation, generic verbs have been used that work with any input
method. In cases where input-neutral verbs do not work, mouse-specific verbs are used as the first
choice, followed by touch-specific verbs as the second choice.
See the following table for examples on how you can interpret the different input methods.
Input-neutral Mouse Touch
Select Modify. Click Modify. Tap Modify.
Select Accounts > Other Click Accounts > Other Tap Accounts > Other
accounts > Add an account. accounts > Add an account. accounts > Add an account.
To open the document in Outline To open the document in To open the document in
view, select View > Outline. Outline view, click View > Outline view, tap View >
Outline. Outline.
Select Protocols. Click the Protocols tab. Tap Protocols.
-NA- Double-click the Client wizard. Double-tap the Client wizard.
Open the Packages context Right-click Packages to open Long tap Packages to open
menu. the shortcut menu. the shortcut menu.
Deprecated words
The following words have been replaced with new words, considering the audience profile, our modern
approach to voice and style, and our emphasis to use input-neutral terms that support all input
methods.
Old usage... New usage...
shortcut menu, right-click menu context menu
click, right-click select
drag and drop drag
913-2383-01 Rev A – iv –
Contact Us iii
Documentation conventions iv
About this guide 1
Note icons and messages 1

CONTENTS
Typographical conventions 1
Textual conventions 2
Chapter 1 Advanced Administration Guide 3
OSS (Operations Support System) Integration 5
MySQL Database Management 6
Hawkeye Database : Enabling Remote Access 11
Hawkeye Database Test Results Structure 15
Test Result Storage Structure 15
Fast backup or restore of Hawkeye MySQL database 17
Backup procedure 18
Restore procedure 18
Probe Management - Probe Busy 18
Captive Portal Support for Wi-Fi 20
Hawkeye Folder Structure 26
Speed Test using Global Servers 26
Set up e-mails with Hawkeye server 26
Hawkeye Ports for Manual Endpoints 29
Manage Manual Endpoints behind NAT 31
–v– 913-2383-01 Rev A

SNMP Configuration and Verification 32
SNMP Traps 33
Hawkeye SNMP MIB Information 36
Associated MIB Descriptors 43
SOAP Web Services API 44
913-2383-01 Rev A – vi –
About this guide
This section explains the notational and typographical conventions used in this documentation, and
provides a list of related documentation.
Section contents:
Note icons and messages 1
Typographical conventions 1
Textual conventions 2
Note icons and messages

The following table describes the note icons and messages used in this document.
Name Icon Description
Note Indicates information that emphasizes or supplements important points in the

main text.
Important Indicates information that is essential to the completion of a task.
Tip Provides supplemental suggestions for applying techniques and procedures to

accomplish a task.
Typographical conventions
The following table describes the typographical conventions used in this document.
Convention Description
bold text Bold text indicates:

l Graphical user interface element names (such as dialog boxes, buttons, menu
selections, and so forth).
l Command line interface commands and options.
l The name of a field, option, or parameter when used as part of an instruction.
For example: “Select the desired Inner Priority value.”
–1– 913-2383-01 Rev A

About this guide
Italic text Italic text indicates:

l A text reference to the name of a field, option, or parameter.
l Document and book titles.
l The first reference to a new term.
l Special identification or emphasis in a statement.
monospace Text shown in a monospace font is used to indicate:

text l Text that you input. For example:
Enter cd project1
l Code samples, including keywords and variables within text and as separate
paragraphs, and user-defined program elements within text.
l Text file content or examples, such as lines of text from an .ini file.
Textual conventions
The following table describes the typographical conventions used in this document.
Boolean text Words that represent Boolean notation are written in all uppercase text.
For example: 192.168.5.5 OR 10.20.30.30.
Keystrokes Simultaneous keystrokes are shown by joining the key names with a plus
sign (+).
For example, CTRL+Q.
> (right angle Separates levels in a hierarchy of menu selections.

bracket) For example: “Select Administration > Users.”
913-2383-01 Rev A –2–

CHAPTER 1 Advanced Administration Guide
This section will cover advanced information on how to administer your Hawkeye server. You need to
have administrator access to the server hosting Hawkeye to be able to use this.
The Hawkeye system is currently based on a CentOS 6.6 system which is derived from the System V
standards. Specifically, the init scripts that control the various services.
The startup scripts themselves are located in /etc/init.d. Each service has its own script that
accepts a specific set of standard commands to control the service in question. The most common
relevant commands for our purposes are the “start”, “stop” and “check” options. These start the
service, stop the service and check the status of the service respectively. Theses commands can
either be run either by passing the command to the script as an option (e.g. “/etc/init.d/httpd
start”), or by using the “service” command (e.g. “service httpd start”), which simply calls the
associated script passing the given command to it.
Most services also have an associated configuration file in /etc/sysconfig to define or override
certain aspects of the script operation or server command line options. These files are normally named
the same as the init scripts they are associated with.
In this chapter:
OSS (Operations Support System) Integration 5
MySQL Database Management 6
Hawkeye Database : Enabling Remote Access 11
Hawkeye Database Test Results Structure 15
Test Result Storage Structure 15
Fast backup or restore of Hawkeye MySQL database 17
Backup procedure 18
Restore procedure 18
Probe Management - Probe Busy 18
Captive Portal Support for Wi-Fi 20
Hawkeye Folder Structure 26
Speed Test using Global Servers 26
Set up e-mails with Hawkeye server 26
–3– 913-2383-01 Rev A

Chapter 1 Advanced Administration Guide
Hawkeye Ports for Manual Endpoints 29
Manage Manual Endpoints behind NAT 31
SNMP Configuration and Verification 32
SNMP Traps 33
Hawkeye SNMP MIB Information 36
Associated MIB Descriptors 43
SOAP Web Services API 44
913-2383-01 Rev A –4–

OSS (Operations Support System) Integration

Hawkeye is designed to be an open framework for easy integration into service providers OSS.
It supports a range of northbound and southbound interfaces that are designed to :
l Export or collect key information and alarms generated by Hawkeye to third party system.
l Automate some tasks from third party tools (generate automatic tests for example).
l Generate customized actions.
Hawkeye SNMP Alarms

Based on test results Hawkeye can trigger an Hawkeye SNMP trap to a third party.
The mib is based on SNMPv2 and is easily imported into supervision systems.
Alarms are generated based on pass fail criteria generated by thresholds.
Hawkeye Email Notifications

Hawkeye can generate automatic emails to configurable recipients (configurable per alert) with alarms
based on test results or thresholds.
Automatic emails can also be sent with content result of aggregated report – these are user defined
and can be scheduled over time (every hour/day/week).
Hawkeye MySQL Database

Hawkeye database has been designed to be efficiently integrated to third party reporting tools.
Therefore, the test data structure storage consists of a simple structure for storing the data record.
Each active test in Hawkeye is considered as a single Data record, recorded into Test Data Record
Table.
Test Data Record contains a set of information describing the test result, with information about:
l Unique ID
l Test execution time
l Pointer to meta data table containing information
Each Test Data record is independent from each other, and independent from any other table in the
database structure, therefore can be displayed as an independent and flat view containing all available
test data.
see MySQL database Management for more details on the test data record structure.
–5– 913-2383-01 Rev A

MySQL Database Management

Hawkeye Database
Hawkeye application uses mysql database 5.1.73
The configuration file for the MySQL server is /etc/my.cnf. This file contains the tuning parameters for
the server as well as defining where the MySQL server stores its data files.
For larger installations, you should consult Ixia Support to determine if any of the values here should
be modified to accommodate the requirements of the specific installation.
On a Hawkeye system, by default, the data tables for the MySQL server are stored in /home/mysql_
data. The expectation is that, on a system with multiple partitions, the /home partition will be a large
local disk partition. If the installation requires NFS mounted home directories, then these files should
be moved to another location on a large local disk.
Example of configuration for a 20G memory server:
[mysqld]
innodb_file_per_table
innodb_flush_method=O_DIRECT
innodb_log_file_size=1G
#log-bin = /home/mysql_data/mysql-bin
#expire-logs-days = 14
#sync-binlog = 1
#tmp-table-size = 32M
#max-heap-table-size = 32M
query-cache-type = 0
query-cache-size = 0
max-connections = 1000
thread-cache-size = 100
open-files-limit = 65535
table-definition-cache = 1024
table-open-cache = 2048
innodb-flush-method = O_DIRECT
#innodb-log-files-in-group = 2
#innodb-flush-log-at-trx-commit = 1
#innodb-file-per-table = 1
innodb-buffer-pool-size = 12G
datadir=/home/mysql_data
socket=/var/lib/mysql/mysql.sock
user=mysql
# Disabling symbolic-links is recommended to prevent assorted security risks
symbolic-links=0
[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid
slow-query-log = 1
slow-query-log-file = /home/mysql_data/mysql-slow.log
913-2383-01 Rev A –6–

The MySQL runs as a service:
l start: service mysqld start

l stop: service mysqld stop
Note: Never attempt to kill mysqld directly this can corrupt the database.
MySQL Web Admin

PHPmyadmin is a web based tool for MySQL administration and advanced configuration. A lot of
information and documentation about this tool can be found at: http://www.phpmyadmin.net/home_
page/docs.php
To access to the Hawkeye Web Portal database administration tool use the following
URL: http://yourserverIP/phpmyadmin.
The default credentials to login are:
l Username: root
l Password: Ixia123
If selected, the complete database will appear and be available, with table size in entries and disk
space.
–7– 913-2383-01 Rev A

Note: Any modifications to the database structure and content directly made into the database
can severely affect operations. This should not be done by non certified engineers and under Ixia
Support supervision.
Hawkeye Database : Changing Root Password

For full advanced procedure refer to: https://dev.mysql.com/doc/refman/5.0/en/resetting-
permissions.html
Using phpmyadmin interface:
1. Log on as root.
2. Select the Users tab.
3. Select Edit Privileges for the root user.
913-2383-01 Rev A –8–

4. Scroll down.
5. Provide a password in Password box and retype it in Re-type box to confirm it. Select GO.
–9– 913-2383-01 Rev A

Note: As soon as the password is modified the Hawkeye application will need to be
reconfigured with new credentials to access mysql database !!! The configuration for
database is in /home/ixia/Hawkeye/conf/configuration.txt.
913-2383-01 Rev A – 10 –
----------------------------------------
## Hawkeye configuration file
[MySQLDatabase]
"MySQL_Host" == "localhost"
"MySQL_Database" == "HawkeyePro"
"MySQL_User" == "root"
"MySQL_Password" == "Password0"
"MySQL_UseSSL" == "0"
6. Change mysql password to new password as reconfigured.
Hawkeye Database : Enabling Remote Access

Using phpmyadmin interface:
1. Login as root.
2. Go to Users tab.
3. Select Edit Privileges for ixia and/or root user (ixia user has restricted privileges).
– 11 – 913-2383-01 Rev A
4. Scroll down.
913-2383-01 Rev A – 12 –
5. Change host from local to any host or Use text field where a specific originating IP can be
specified.
We recommend you to leave default option to leave the old host.
As noted below the Windows firewall port must be opened for inbound request to MySQL.
Note: This will grant access to other servers to the database information. This can create
security issues if not completely under control.
Note: The default listening port for mysql database is 3306. Windows firewall must be opened
inbound for this port so that other servers can connect to it.
Hawkeye Database : run sql Script

Some advanced modification sql scripts are sometimes required for ad hoc bug fixing or applying a
patch on the server.
These would typically be provided by Ixia support.
We recommend you to run them through phpmyadmin (command line using mysql tool is also possible,
refer to corresponding mysql user guide for this).
1. Log on to phpmyadmin (preferably as root user).

2. Select the Hawkeye database.
– 13 – 913-2383-01 Rev A
3. Select the SQL tab.
4. Paste the required query into the text area.
913-2383-01 Rev A – 14 –
5. Select Go to run the query.
Hawkeye Database Test Results Structure

l Hawkeye solution has an underlying database scheme that is used for:
l System information and administration management;
l Test execution Queue Management;
l Test Results storage.
Test Result Storage Structure

Test Data Record Concept
Hawkeye database has been designed to be efficiently integrated to third party reporting tools.
Therefore, the test data structure storage consists of a simple structure for storing the data record.
Each active test in Hawkeye is considered as a single data record, recorded into Test Data Record
Table.
Test data record contains a set of information describing the test result, with information about:
l Unique ID;
l Test execution time;
l ID to test_data_record_filters table
l Reason cause;
– 15 – 913-2383-01 Rev A
Each test data record is independent from each other, and independent from any other table in the
database structure, therefore can be displayed as an independent and flat view containing all available
test data.
The test_data_record_filters table contains meta data to more information about node from, node to,
test type etc... each test_data_record is linked to a test_data_record_filters . A join query on the 2
tables will allow to get explicit information about the content.
KPI Result Table

Each Test Data Record may contain a set of KPI (Key Performance Indicators) that will contain the
information about each performance indicator, and value for the data record.
A database table called kpi_result_table contains the information about the KPI. Each KPI result has to
be linked to the test_data_record (using TDR_ID).
A table called kpi_result_table_filters is linked to kpi_result_table and contains information about

metric and test pair for which the metric is stored as well as status.
another table called kpi_string_information is linked to TDR and contains string kpi typically used to
provide further description of a test result.
One Test Data Record (TDR) can contain as many results as needed in string or integer format.
Each KPI result contains:
l A link ID to relate to the corresponding TDR with all test information;

l A value;
l A threshold Value (defining the threshold used to define PASS / FAIL);
l A threshold type (define the type of the threshold, less than, more than, percentage, etc..).
It also contains a link to the kpi_result_table_filters which contains
l A metric name;
l A pair name (to identify a specific pair in a set of tests, for example when using COS testing or
traffic mix);
l A Status (PASS/FAIL).
KPI Detailed Result Table

Some metrics (not all) may be recorded in a test with intermediate results within a single test. When
Test Data Record is created, these metrics are stored into kpi_detailed_table. These results are used
to create graphs of a single Test for the available metrics.
Each detailed KPI entry contains:
l A link ID to relate to the corresponding TDR with all test information;

l A metric name;
l A pair name (to identify a specific pair in a set of tests, for example when using COS testing or
traffic mix);
l A timestamp, which is starting from 0 (when test begins and go to a maximum (in seconds) which
913-2383-01 Rev A – 16 –
is the total test duration of the TDR

l A value;
MySQL Test Data Dtructures

The following drawing illustrates the different tables mentioned above and their structure.
Standard SQL queries shall be made to get these into any reporting, data mining or data post
processing engines.
MySQL advanced configuration for performance

See Optimizing MySQL.
Fast backup or restore of Hawkeye MySQL database

Some organizations may have a need to do a weekly/monthly back of the Hawkeye Server MySQL
database. The backup and restore scripts use a multi-threaded third party tool for a fast backup and
restore of the MySQL database.
– 17 – 913-2383-01 Rev A
Backup procedure
These backup and restore scripts are configurable. The scripts are located on the Hawkeye Server in
the following directories.
/home/ixia/Hawkeye/tools/fast_backup_db
/home/ixia/Hawkeye/tools/fast_restore_db
The mydumper and myloader commands within the scripts can be customized by the user to specify
the location of the backup directory and the number of threads used. Default is 10 threads. For larger
Hawkeye Server’s with more CPU cores, more threads may be configured.
Note: Hawkeye by default does not define a host (default localhost) so no need to define ‘host’
parameter for mydumper command.
The fast backup scripts will stop Hawkeye Server while the backup and restore is being performed,
then restart all services once backup complete. This means while database is being backed up all
scheduled tests will be paused. It is recommended to schedule a Linux cron job to perform a backup at
the weekend or early morning hours. The default location for the output of the backed-up MySQL
database is /home/ixia/DB_backup. The backup location can be customized.
The fast backup is performed as follows. It is the responsibility of the user to zip and move this backup
directory to another location:
# cd /home/ixia
# ./home/ixia/Hawkeye/tools/fast_backup_db
# tar cfvz DB_backup.tar.gz DB_backup/
The backup file can now be moved to another system.
Restore procedure
After the new Hawkeye server VM has been created and licensed. Transfer the previously gzipped
backed up database to the new Hawkeye Server VM and prepare the gzipped file for restore with the
following commands.
# cd /home/ixia
# tar xvfz DB_backup.tar.gz
Then restore the MySQL database with the fast restore script as follows
# ./home/ixia/Hawkeye/tools/fast_restore_db
This will restore the MySQL database and restart all services on the Hawkeye Server.
Probe Management - Probe Busy

Hawkeye supports the ability for a custom script on an endpoint to determine when the probe is busy
and therefore unavailable for tests. The Hawkeye Server in Probe Management indicates when an
endpoint is down or up. This feature introduces a third state of busy for the endpoint. When a probe
becomes busy, the state will be reflected in Probe Management in blue for that probe and it will not
913-2383-01 Rev A – 18 –
be available to run tests. All scheduled tests will remain in a queued state until endpoint leaves the
busy state.
To turn on this feature, go to Preferences > Advanced Options and select Probe Busy parameter.
A user defined script is placed on all endpoints that the probe busy feature is intended for. The purpose
of the endpoint probe busy script is to determine when the probe is busy and not available for tests.
You should define the script on the probe that determines when a probe is busy. The Hawkeye server
will send a command down to each endpoint every so many seconds to execute the script and retrieve
the busy status. The frequency of requesting probe busy status is determined by the Hawkeye System
Preference parameter Real services: default interval time for automatic endpoints in
Advanced Options tab.
When the feature probe busy is turned on, it is not necessary for all endpoints to contain the busy
script. For all endpoints not containing the busy script, a result of not busy will be returned.
Below a sample script indicates a probe is busy for a defined period each day.
Use case
This is an example probe busy script which indicates a probe is busy during the peak network busy
time of early evening.
Note: Use ssh to connect to the endpoint and create the probe busy script as below. The script
must be in the specified directory and use the specified filename.
1. Create a file on the endpoint named testIfProbeBusy with the following script.
# cd /home/ixia/
# nano testIfProbeBusy.py
#!/usr/bin/python
import datetime
import sys
# use format HHMM
simulate_unavailable_start_time = "1326
simulate_unavailable_end_time = "2100
debug = 0
test_start_time = datetime.datetime.now()
test_start_time_str = test_start_time.strftime('%d-%b-%y %H:%M:%S')
test_start_hhmm = test_start_time.strftime("%H%M")
if test_start_hhmm >= simulate_uanavailable_start_time and test_start_hhmm <=
simulate_uanavailable_end_time:
endpoint_busy = 1
else:
endpoint_busy = 0
if debug > 0:
sys.stdout.write('\nDEBUG: %s endpoint_busy=%s unavailable from %s to
%s \n' %
(test_start_time_str, endpoint_busy, simulate_uanavailable_
start_time,
simulate_uanavailable_end_time))
– 19 – 913-2383-01 Rev A
sys.exit(endpoint_busy)
2. Next ensure script is available for executable
# chmod +x /home/ixia/testIfProbeBusy
3. On the Hawkeye server UI, under Administration > Preference > Advanced Options, turn
on the Probe Busy.
The Hawkeye server will now send frequent commands (default every 5 seconds) down to each
endpoint to run the testIfProbeBusy script. The script will return “1” if busy or “0” if available for tests.
The Probe status for the endpoint will reflect busy with a blue color when busy. If an endpoint does not
contain the script it will always return a not busy status.
When a test runs and the probe is blue indicating busy, the test will enter a queued state. If the test is
scheduled to run every minute only one instance of that test will be queued. The scheduled test will
continue as normal when probe becomes available. If three different tests are scheduled to run each
minute against the probe only one instance of each of the three tests will be queued until probe
becomes available.
Note: Python is an application needed to run the probe busy scripts. Python is included for XR
endpoints. You may, however, need to load it on software endpoints, if not already present.
Captive Portal Support for Wi-Fi

Hawkeye previously supported the use of Captive Portal on the XRPi when connecting to a Wi-Fi
network. As the version of Firefox and Selenium IDE is now no longer actively supported for the XRPi,
support for Captive Portal is suspended until another solution can be implemented.
This section is for historical purposes and explains how a Customer at their own risk can use and build
a captive portal script to go through the steps to login via a web interface into the Wi-Fi network.
This section explains how to use and build a captive portal script to go through the steps to login via a
web interface into the Wi-Fi network.
Follow the guidelines given below to build a captive portal script, so that an XRPi can connect to an
organizations Captive Portal using the Wi-Fi Connect Test. To install and use the Captive Portal scripts
on the Hawkeye server, complete the following:
1. Confirm prerequisites are met.

2. Manually perform Captive Portal operation.
3. Connect to Captive Portal and save the script.
4. Adapt and verify the script.
5. Run the script from Hawkeye.
Prerequisites
Before you start using captive portal on Hawkeye, you need the following:
l An XRPi with Wi-Fi dongle

l A computer with ssh client and X server, see Finalize installation on XRPi
l A connection to the network with the captive portal you need to build the script for
913-2383-01 Rev A – 20 –
l Basic Python scripting skills

l Basic CLI Linux skills
Ixia highly recommends the time on the XRPi is synced to the time on the XRPi. If this is not aligned,
the web browser will appear very slow. Using a CLI on the XRPi issue the ‘date’ command to compare
time to that on the Hawkeye server. The following set of instructions ensure the time is correct on the
XRPi:
l service ntp stop

l ntpdate pool.ntp.org
l service ntp start
You can also set the correct timezone by choosing a city under the /usr/share/zoneinfo directory:
ln -sf /usr/share/zoneinfo/America/New_York /etc/localtime

Manually Perform Captive Portal Operation
Ensure that you have Xserver running on your system so the display for the XRPi will appear on your
system. It is recommended that you use Xming on a windows machine.
1. Run Xming so that you have X11 server active.

2. Establish a new ssh connection to the XRPi and enable X11 forwarding.
3. Log on as root on the XRPi ssh and run Firefox.
# firefox &
Firefox will open a popup window on your system in Xming.
4. Go to the following link in Firefox to add Selenium IDE as an extension:
https://addons.mozilla.org/en-GB/firefox/addon/selenium-ide/versions/?page=1#version-
2.9.1.1-signed.
5. Select Download Anyway.
6. On pop up, select Save file.
7. Select the download arrow, after download is complete.
8. Drag selenium_ide-2.9.1-fx.xpi to the the mozilla/firefox window.
9. On the pop up asking if want to install Selenium IDE, select Install .
10. Select Restart firefox now.
Note: You need to restart Firefox. After you restart ensure that you activate the
SeleniumIDE add-on.
11. Ensure the XRPi is connected to Wi-Fi. Ixia recommends using the Wi-Fi connect option for the
XRPi in Probe management on the Hawkeye web client to connect to the Wi-Fi AP. It is important
to select none for authentication method. After the operation is complete, confirm XRPi has a Wi-
Fi dhcp IP address.
Connect to Captive Portal and Save Script

To record your script, do the following:
– 21 – 913-2383-01 Rev A
1. Select the top right Selenium IDE button, on your Firefox browser to launch a pop-up for
selenium.
2. Select the red button on the top right corner of the Selenium pop-up to start the recording.
3. Go to the browser and open any website. The system redirects you to the captive portal.
4. Log in with the credentials for your organization.
5. In the Selenium window, select the red button to stop the recording. Login details will be
displayed in the table pane.
6. In the Selenium window from the File pull down menu select Export Test Case as > Python
2/ unittest/ WebDriver and choose a directory and file on the XRPi. Ixia recommends
/tmp/scriptname.py.
7. On the XRPi go to the directory where you saved the file and confirm the script has been saved
with the command cat /tmp/scriptname.py.
Note: Ensure that you save the script with .py extension.
8. Close Selenium and ensure you do not select save again as it will change the script being saved
in the file.
9. Close Firefox.
Adapt and Verify the Script

SSH to the XRPi and go to the location where you stored your captive portal record script
(scriptname.py). You can run your script again using the command:
python scriptname.py.
This will invoke Firefox and go through the same steps as recorded previously of logging into the web
site. The Captive portal for each organization is slightly different so you may have to rework the script
to successfully log in. You will need to edit the script, make some changes then run the script until it
successfully enters the username/password to authenticate the user. Below is a list of common
changes that may need to be made:
l Add a wait delay between passing the URL to the webdriver. This would mean adding the line
“time.sleep(1)”.
l Verify the generated url in script is correct. The URL may need to be modified or replaced with
direct reference to URL for Organizations captive portal.
l The Organizations captive portal site may invoke a pop-up for login credentials. If a pop-up for
login credentials appears, as a result of re-direction, it is possible to prevent the pop-up by
making the following script change (see Example 3 below):
n On line for driver.get(self.base_url + "/gp2/webportal…”), replace this with driver.get
(self.base_url)” .
l Use the Inspect feature of firefox to identify the name of the identifier for login, password and
the authenticate button. These may need to be updated as per Example 3 given below.
l User may want to add wrapper in Python to add more logic. This may require advanced
knowledge of python scripting. Contact Ixia Customer support if assistance required.
Below are some working examples:
Example 1:
913-2383-01 Rev A – 22 –
from selenium import webdriver

driver = webdriver.Firefox()
driver.get("http://www.google.com")
elem = driver.find_element_by_name("login")
elem.clear()
elem.send_keys("user1")
elem = driver.find_element_by_name("password")
elem.clear()
elem.send_keys("ppp")
elem=driver.find_element_by_name('Submit')
elem.click()
#html_source=driver.page_source
html_source=driver.title
print "%s" % html_source
text_file = open('/tmp/seleniumoutput.txt', 'w')
text_file.write("%s" % html_source[:300])
text_file.close()
driver.close()
Example 2:
# -*- coding: utf-8 -*-

from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.support.ui import Select
from selenium.common.exceptions import NoSuchElementException
from selenium.common.exceptions import NoAlertPresentException
import unittest, time, re
import os
class Ixiaguest(unittest.TestCase):
def setUp(self):
self.driver = webdriver.Firefox()
self.driver.implicitly_wait(30)
# self.base_url = "https://guest.ixiacom.com:8443"
self.base_url = "http://www.google.com"
self.verificationErrors = []
self.accept_next_alert = True
def test_ixiaguest(self):
driver = self.driver
# driver.get(self.base_url +
"/gp2/webportal/ext/webPortalAuthLogin?portal_ip=10.212.240.1
– 23 – 913-2383-01 Rev A
32&client_
id=74%3Ada%3A38%3A90%3A89%3Af5&wbaredirect=http%3A%2F%2Fwww.google.com%
2F&ssid=IXIA+Guest&bssid=28%3A8a
%3A1c%3A21%3A23%3A02")
driver.get(self.base_url)
driver.find_element_by_id("webPortalAuthUsername").clear()
driver.find_element_by_id("webPortalAuthUsername").send_keys
("nribault")
driver.find_element_by_id("webPortalAuthPassword").clear()
driver.find_element_by_id("webPortalAuthPassword").send_keys("IJ2W5Z")
driver.find_element_by_css_selector("img[alt=\"Authenticate\"]").click
()
def is_element_present(self, how, what):
try: self.driver.find_element(by=how, value=what)
except NoSuchElementException as e: return False
return True
def is_alert_present(self):
try: self.driver.switch_to_alert()
except NoAlertPresentException as e: return False
return True
def close_alert_and_get_its_text(self):
try:
alert = self.driver.switch_to_alert()
alert_text = alert.text
if self.accept_next_alert:
alert.accept()
else:
alert.dismiss()
return alert_text
finally: self.accept_next_alert = True
def tearDown(self):
self.driver.quit()
self.assertEqual([], self.verificationErrors)
hostname = "google.com" #example
response = os.system("ping -c 1 " + hostname)
#and then check the response...

if response == 0:
print hostname, 'is up!'
if __name__ == "__main__":
913-2383-01 Rev A – 24 –
unittest.main()
else:
print hostname, 'is down!'
if __name__ == "__main__":
unittest.main()
Example 3:
class IxiaGuestLoginTest1(unittest.TestCase):
def setUp(self):
self.driver = webdriver.Firefox()
self.base_url = "https://guest.ixiacom.com:8443/"
self.verificationErrors = []
self.accept_next_alert = True
def test_ixia_guest_login_test1(self):
driver = self.driver
driver.get(self.base_url)
driver.find_element_by_name("j_username").clear()
driver.find_element_by_name("j_username").send_keys("mtest2")
driver.find_element_by_name("j_password").clear()
driver.find_element_by_name("j_password").send_keys("H69KGR")
driver.find_element_by_name("submit").click()”
Note: Continue when you have a working script.
Run the Script from Hawkeye

To run the script from Hawkeye, do the following:
1. Move your Python script into /home/ixia/Hawkeye/WebServer/uploads/, then ssh to the

Hawkeye Server and go to this directory. All files in this directory will survive a Hawkeye Server
software upgrade.
2. Create a second file in /home/ixia/Hawkeye/WebServer/uploads/ called ixiaportal. The file
ixiaportal will contain the single command line xvfb-run python
/home/ixia/Hawkeye/WebServer/uploads/scriptname.py>/tmp/outputselenium.lo
g 2>&1.
3. Change the protection on both files to allow anyone to execute by using the following CLI
commands:
l chmod +x /home/ixia/Hawkeye/WebServer/uploads/ixiaportal
l chmod +x /home/ixia/Hawkeye/WebServer/uploads/scriptname.py
The Real service test, Wi-Fi Connect, has a configuration field for Captive Portal Script, the user
can enter the path and name /home/ixia/Hawkeye/WebServer/uploads/ixiaportal so the
captive portal script can be run to complete connection to the organizations network.
– 25 – 913-2383-01 Rev A
Note: Important to note the Wi-Fi connect test may give a status of Fast re-authentication
in the test results. If the organizations network supports fast re-authentication, the AP will know
that within a certain time period the XRPi is still logged on, so will automatically allow the XRPi
to connect without authenticating the user with the Radius server (authentication server).
Hawkeye Folder Structure

The Hawkeye application is installed in /home/ixia/Hawkeye. The Hawkeye application generates a
number of log files which are automatically rotated to manage disk space. The user does not need to
refer these log files unless advised by Ixia Customer Support.
The following directories contain log files:
l System log files are in /var/log directory.

l Individual Node to Node and Mesh test details or statistics files from endpoints are in
/home/ixia/Hawkeye/logs/Chariot directory.
l Hawkeye system files and real service test logs are in /home/ixia/Hawkeye/logs/Hawkeye
directory.
Speed Test using Global Servers

The real service speed test uses servers located all over the world to calculate round trip delay along
with uplink and downlink throughput. Procedure for speed test real service activation :
1. Login to Hawkeye server (using ssh)

2. Locate the /tmp directory (cd /tmp)
3. Download updated speedtest server list:
# wget http://www.speedtest.net/speedtest-servers.php -O /tmp/testservers.xml
Note: If the server is offline, you must download the content and copy the file to /tmp
directory.
4. Run the command for import.
# php -c /home/ixia/Hawkeye/conf /home/ixia/Hawkeye/ServerScripts/populate_
speedtest.php /tmp/testservers.xml
The speed test real service test will be available in GUI.
Set up e-mails with Hawkeye server

Hawkeye server supports the use of emails in three ways.
l Deliver generated reports though e-mails.

l Deliver error notification e-mails of test results including failure or error reasons.
l Deliver real service test e-mails for XR2000 only.
To send reports and test results in e-mails, you must make available a mail client and configure it for
the Hawkeye server. You do not need to configure mail client for Hawkeye server for real service tests.
913-2383-01 Rev A – 26 –
Configure e-mail for reports and test results

Configure Email section in Administration > Preferences of Hawkeye server UI to set up a mail
client. You will need to configure your SMTP server settings and your organization’s e-mail account
credentials in this section for the Hawkeye server to send e-mails.
Configure an Email SMTP server in Preferences. Following is a sample configuration.
SMTP server: mail.smtp2go.com
SMTP Authentication: Enable
SMTP Security: SSL (match whatever your email service uses SSL/TLS?)
Port: 465
Note: Configure port 465 for SSL, 587 port for TLS or 25 default SMTP port for no security, no
other value is supported. Port 25 was the most commonly used port, but for security many email
providers now block it as it is used by spammers.
Username: freds_fish_n_chips@gmail.com
Note: This e-mail address is for reference.
Password: ********
Email address: freds_fish_n_chips @gmail.com
Full name: freds_fish_n_chips @gmail.com
Note: These are the credentials from e-mail server.
Max Email attempts: 3
Note: The e-mail process is abandoned after maximum attempt is attained.
Workflow of sending and retrieving e-mails

Outgoing and incoming mail are handled by two different types of server.
l SMTP server to send e-mail

l POP3/IMAP server to retrieve e-mail
You send email from your mail client (now running on Hawkeye server) by using the configured email
address to the outgoing SMTP server using the configured port. The SMTP server first validates security
and authentication, that is, connection security (SSL/TLS/25), port, username, password. The SMTP
server works like the post office and performs a DNS lookup to find where to send the email
(destination domain). The SMTP server may store the actual email on a local server (owned by domain
sender) close to the Hawkeye server instead of the main SMTP server (that is, gmail in the above
sample configuration). The SMTP server then sends the email to the destination domain Message
– 27 – 913-2383-01 Rev A
Transfer Agent (MTA) server for long term storage. If the email destination domain is the same as the
source (that is, gmail in the above sample configuration), the SMTP server will act as the MTA server.
If different sender/dest email domain and no issues, it can be routed or forwarded. The email is sent by
SMTP protocol to the (destination domain) MTA server. The received email is stored on the destination
domain MTA (POP3/IMAP) server. The MTA (POP3/IMAP) server uses POP3 or IMAP protocol to transfer
email to recipient’s inbox (email client on the computer) when requested.
Workflow of real service test e-mail

Real service test e-mail works by using an email client on the probe. Only the XR2000 currently
supports an email client. Configuring the Email section of Preferences is not used in this case.
Configure real service test email

Configure the following parameters to send and receive real service test emails.
l Sending email server credentials

l Email address
l Outgoing Mail server
l Outgoing Mail port
l SMTP authentication: SSL
l SMTP Authentication user
l SMPT Authentication password
l Receiving email server credentials
l Incoming mail server
l Incoming mail port
l Incoming mail protocol
l Mail user
l Mail Password
The real service test e-mail times different stages, but most important is when the destination
POP3/IMAP server receives the sent email. Probe will poll every second to check received email.
913-2383-01 Rev A – 28 –
Hawkeye Ports for Manual Endpoints

The following diagram displays the information about the ports that are required for management and
traffic for the probes/endpoints:
Port or Port
Range
Modification
Description Port(s) Policy Protocol Directions Description
Hawkeye 10115 Modifiable TCP From Server Mandatory for node to node
Server to with to probes and mesh testing.
probes test advanced (hardware
management configuration and
node to node (contact Ixia software).
and mesh Support).
Hawkeye 22,10000* Modifiable TCP From Server Mandatory for advanced

Server to with to probes probes administration and
probes Real advanced (hardware real services executions.
Services configuration probes Port 10000 optional for web
(contact Ixia only). admin of XR2000 and XRPi
Support). - requires web admin
activation on XR2000 or
XRPi.
– 29 – 913-2383-01 Rev A
Port or Port
Range
Modification
Description Port(s) Policy Protocol Directions Description
Probes to 80,443* Modifiable TCP From Probes Required for probe auto
Hawkeye with to server. registration process - ONLY
Server - auto advanced for automatic endpoints.
registration configuration
(contact Ixia
Support).
Probe to 10115 Modifiable TCP AND Probe to Mandatory for node to node
probe with UDP Probe, and mesh testing.
management advanced bidirectional. UDP port is only required
configuration for tests with
(contact Ixia synchronization (network
Support). KPI, any real time traffic).
Probe to User Modifiable TCP From Probes Default to AUTO which

Probe traffic defined with to server. picks any port available on
administrator probes. Need to be
console. enforced in Hawkeye
configuration in case of FW
between Probes.
913-2383-01 Rev A – 30 –
Manage Manual Endpoints behind NAT

It is highly recommended to use automatic endpoints for probes behind NAT.
Required Port Forwarding

Some NAT port forwarding needs to be configured on the NATing device so that ports are forwarded to
the probes.
The ports that need to be port forwarded:
For management:
l port 10115 and 10116 for TCP and UDP (UDP is needed for time sync for Voice or Video pairs, or
any RTP pairs) and port 10117 TCP to the Hawkeye server.
l port 22 for Real Service testing. Port 22 is also used for XR2000 hardware probes to manage the
probes remotely.
For traffic:
l port 10120 - 10140 (example). A larger range may be needed if more concurrent pairs of traffic
are set against the NATed probe as destination.
TCP/UDP port needs to be configured for port forwarding depending on the nature of traffic.
This must be set in the configuration of the system as well to consider the traffic sent. See the
following section for more information on handling NAT.
Hawkeye Configuration for NAT

When NAT is applied, an endpoint may have a public and a private IP. These can be viewed in Probe
Management for the endpoint. Need to make sure the private IP of destination endpoints are added to
the NAT table. On the Hawkeye server, there are 2 steps to configure Hawkeye for NAT:
– 31 – 913-2383-01 Rev A
1. In Administration > Preferences > Test Engine Tab, set the autoNAT to 1.
2. Force traffic to be in range 10200 - max Range. First enable the user configured range by setting
the Administration > Preferences > Traffic Port Management > Destination Port
conf option to 1. Then, define the traffic range by setting Administration > Preferences >
Traffic Port Management > First Destination Port to 10116.
SNMP Configuration and Verification

You can configure and verify the Simple Network Management Protocol (SNMP). This section explains
how to configure and verify the SNMP.
913-2383-01 Rev A – 32 –
SNMP Traps
Hawkeye server supports the generation of SNMP traps for tests originated from endpoints. Tests
configured to generate SNMP traps on certain error/failure conditions sends the SNMP traps in MIB
format to a designated SNMP server.
There are six steps involved:
l How to use SNMP traps

l Verify Hawkeye Server MIBs file can be interpreted by the User’s SNMP server
l Configure HawkeyeServer in Preferences to send SNMP trap to a specific User’s SNMP server
l Configure User’s SNMP server to receive Hawkeye server originated SNMP traps
l Enable SNMP traps to be triggered for endpoint scheduled tests
l Verify SNMP trap successfully received and decoded by SNMP server
l Advanced Troubleshooting – Monitor Hawkeye server SNMP debug logs
How to use SNMP Traps

SNMP traps can be configured to be triggered by test results on end points. The time between tests and
consequently the possible reporting time between SNMP traps is Customer configurable. The shortest
time between tests on an endpoint is one minute.
SNMP traps are supported for all test types. When configuring a test, select Show Alarm options to
see the SNMP configuration.
Each test can be enabled to trigger SNMP traps, based on a failure or error result. There is the option to
only report an SNMP trap on a change. This means if a test on an endpoint is scheduled to run every 5
minutes and it is failing every time, it is only reported as an SNMP trap the very first time it fails, then
it generates another SNMP trap once the endpoint test result changes to be an error or passes.
Verify Hawkeye Server MIBs file can be interpreted by the User’s SNMP
server
Hawkeye SNMP traps encoding is identified by three files. Retrieve the following three MIBs files from
the Hawkeye server so that they can be verified:
putty (ssh) to hawkeye server (username/password - root/ixia123).

Files required:
l /usr/share/snmp/mibs /NET-SNMP-MIB.txt
l /home/ixia/Hawkeye/includes/MIBS/Hawkeye-MIB.txt
l /home/ixia/Hawkeye/includes/MIBS/IXIA-SMI.txt
There are a number of independent free web sites that verify that custom MIB files confirm to correct
standards.
Suggested free independent web sites to verify Hawkeye MIBs format:
http://www.simpleweb.org/ietf/mibs/validate/upload.php
http://www.muonics.com/Tools/smicheck.php
– 33 – 913-2383-01 Rev A
From these web sites pull in the retrieved two Hawkeye files and validate to MIBs standards. There are
three supported versions of MIB files (v1, v2 and v3).
Configure Hawkeye Server to send SNMP trap to a specific SNMP server

Enable SNMP traps to be generated by the Hawkeye server.
To enable the SNMP traps, do the following:
Go to Administration > preferences > Alarms toggle the Enable/disable the alarms

received using SNMP.
Also configure the IP address of the your SNMP trap server, to which the SNMP traps are to be sent to.
Multiple SNMP trap receivers can be supported by using a third party application that will forward
received UDP packets from the Hawkeye Server IP address/port to a defined list of destination SNMP
trap receivers (IP/port). There are many free applications that are available for this purpose, such as
the free linux samplicator application. The SNMP server IP defined on the Hawkeyeserver to achieve
this will be the IP of the third party application doing the forwarding.
Configure your SNMP server to receive Hawkeye server originated SNMP

traps
There are many SNMP servers (receiver) available but the required basic configuration is as follows:
1. Load in the two Hawkeye MIB modules identified and retrieved from the Hawkeye server in the
above steps (NET-SNMP-MIB.txt, IXIA-SMI.TXT and Hawkeye-MIB.txt). This enables your SNMP
trap server to decode the Hawkeye SNMP traps.
2. Configure the host address of the Hawkeye server that will be the source of the SNMP traps.
3. Set the host port used to generate and be monitored for the SNMP traps to 162.
4. Set the community to ixia.
5. Following a Hawkeye Server upgrade, remove, flush, or delete any Hawkeye MIB files from the
SNMP server (receiver) and pull in the latest version as new test types. Else, changed test
metrics will cause decode issues.
Enable SNMP traps to be triggered for endpoint scheduled tests

1. Schedule a test (example, node to node Skype4B traffic test) on probes expected to generate
SNMP traps on error/failure conditions.
2. When configuring the test, set thresholds to expected values additionally select Show Alarm
Options.
3. Go to Show Alarm Options and enable the SnmpTrap.
4. Also select the conditions for the alarm to be triggered that generates the SNMP Trap
(Error/Failed/Status change).
Verify SNMP trap successfully received and decoded by SNMP server

Invoke SNMP trapviewer from your SNMP server. Generate SNMP trap by running Hawkeye test that
fails. Confirm that the SNMP trap received in the trap viewer is as expected and can be decoded.
913-2383-01 Rev A – 34 –
Advanced Troubleshooting – Debug SNMP packet routing issues

Putty (ssh) to Hawkeye server (username/password - root/ixia123) and monitor SNMP trap logs to
confirm that tests are triggering sending of SNMP traps to SNMP server.
On the Hawkeye server go to directory /home/ixia/Hawkeye/logs/Hawkeye and monitor server

daemon logs with the following command.
tail -f ServerDaemon.log
Confirm able to see logs such as the one below where the first IP address is the IP address of the SNMP
server to receive the SNMP trap.
20:24:58 UTC (Alarm send) sending snmptrap -

snmptrap -M /usr/share/snmp/mibs/:/home/ixia/Hawkeye/includes/MIBS -c ixia -v 2c
10.220.120.11 "" HAWKEYE-MIB::hawkeye-notification trapID s "xr2000autoqa2xrpiWi-
Fiqa2Skype4BTrafficDelaymsAudioRTPfromto12kbpsFAIL" summary s "xr2000autoqa2 to
xrpiWi-Fiqa2 Skype4B Traffic Audio RTP fromto 12 kbps Delay ms Failed" runID s
"8285" TimeStamp s "2016-11-30 20:24:57" TestType s "Skype4B Traffic" TestStatus
s "Failed" From s "xr2000-auto-qa-2" To s "xrpi-Wi-Fi-qa-2" PAIRNAME s "Audio RTP
from->to 12 kbps" MetricName s "Delay (ms)" METRICVALUE s "2.5"
DefaultThresholdType s "1" THRESHOLD s "9000" METRICSTATUS s "Failed" FailReason
s " Threshold failed on Audio RTP from->to 12 kbps Delay (ms) "
Additionally use TCP dump command to confirm that the SNMPtrap packet is not being blocked in the
network. The TCP logs below (taken from Hawkeye server) show that a SNMP trap is generated from
Hawkeye server (10.220.120.127) and sent to the SNMP trap server/receiver (10.220.20.45) but is
blocked as unreachable.
TCP dump from Hawkeye server:
tcpdump -n -i eth0 | grep -i "10.220.120.127"

21:11:38.246127 IP 10.220.120.127.52365 > 10.220.20.45.snmptrap: C=ixia V2Trap
(183) .1.3.6.1.2.1.1.3.0=148999358
.1.3.6.1.6.3.1.1.4.1.0=.1.3.6.1.4.1.8072.2.1.0.3 .1.3.6.1.4.1.8072.2.1.2.1=3
.1.3.6.1.4.1.8072.2.1.2.2="Amazon-KFFOWI" .1.3.6.1.4.1.8072.2.1.2.3="Amazon-
KFFOWI" .1.3.6.1.4.1.8072.2.1.2.4="0" .1.3.6.1.4.1.8072.2.1.2.5="TestAgent1"
21:11:38.247491 IP 10.220.20.45 > 10.220.120.127: ICMP 10.220.20.45 udp port
snmptrap unreachable, length 234
In the above example, unlike the Network Unreachable and Host Unreachable messages which come
from routers, the Port Unreachable message comes from the SNMP server/receiver. The primary
implication for troubleshooting is that the frame was successfully routed across the communications
infrastructure, the last router ARP'ed for the host, got the response, and sent the frame. Furthermore,
the intended SNMP server (destination host) was on-line and willing to accept the frame into its
communications buffer. The frame was then processed and an attempt was made to send the data up to
the destination port number (UDP port 162) and the port process (SNMP server) did not exist. The
protocol handler then reports Destination Port Unreachable.
– 35 – 913-2383-01 Rev A
For SNMP traps generated by Hawkeye Server to reach a third party SNMP trap receiver the UDP ports
161 and 162 need to be open for UDP traffic on the Hawkeye server and switches between the two
parties. One way to open the ports on the Hawkeye Server is to putty to the Hawkeye Server then
using the following CLI commands to open the firewall for SNMP traffic:
# iptables -I INPUT -p udp -m udp --dport 161 -j ACCEPT

# iptables -I INPUT -p udp -m udp --dport 162 -j ACCEPT
# iptables-save > /etc/sysconfig/iptables
Hawkeye SNMP MIB Information

This section covers information about SNMP MIB provided by Hawkeye
MIB file location

MIB files can be found into the following directory /home/ixia/Hawkeye/includes/MIBS
MIB file IXIA-SMI.txt content

IXIA-SMI DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-IDENTITY,
enterprises
FROM SNMPv2-SMI;
ixia MODULE-IDENTITY
LAST-UPDATED "201701040000Z"
ORGANIZATION "www.ixiacom.com"
CONTACT-INFO
" Ixia Communications
Postal: 26601 W. Agoura Rd.
Calabasas, CA 91302
USA
Email: support@ixiacom.com"
DESCRIPTION
"The Structure of Management Information for the
Ixia Communication enterprise."
::= { enterprises 3054 } -- assigned by IANA
ixiaProducts OBJECT-IDENTITY
STATUS current
DESCRIPTION
"ixiaProducts is the root OBJECT IDENTIFIER from
which sysObjectID values are assigned."
::= { ixia 1 }
END
913-2383-01 Rev A – 36 –
MIB file Hawkeye-MIB.txt content

HAWKEYE-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
Integer32,
NOTIFICATION-TYPE
FROM SNMPv2-SMI
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
ixiaProducts
FROM IXIA-SMI;
hawkeye MODULE-IDENTITY
LAST-UPDATED "201701040000Z"
ORGANIZATION "www.ixiacom.com"
CONTACT-INFO
" Ixia Communications
Postal: 26601 W. Agoura Rd.
Calabasas, CA 91302
USA
Email: support@ixiacom.com"
DESCRIPTION
"Hawkeye MIB objects for trap notifications"
REVISION "201604260000Z"
DESCRIPTION
"Hawkeye MIB"
REVISION "201402060000Z"
DESCRIPTION
"First draft"
::= { ixiaProducts 1 }
hawkeye-notifications OBJECT IDENTIFIER ::= { hawkeye 1 }

hawkeye-notificationprefix OBJECT IDENTIFIER
::= { hawkeye-notifications 0 }
hawkeye-notificationobjects OBJECT IDENTIFIER
::= { hawkeye-notifications 2 }
probeID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS accessible-for-notify
STATUS current
– 37 – 913-2383-01 Rev A
DESCRIPTION
""
::= { hawkeye-notificationobjects 1 }
probeMgtIP OBJECT-TYPE
SYNTAX SnmpAdminString
STATUS current
DESCRIPTION
""
probeName OBJECT-TYPE
STATUS current
DESCRIPTION
""
probeStatus OBJECT-TYPE
SYNTAX INTEGER {
down(0),
up(1)
}
STATUS current
DESCRIPTION
""
testAgentName OBJECT-TYPE
STATUS current
DESCRIPTION
""
runID OBJECT-TYPE
913-2383-01 Rev A – 38 –
STATUS current
DESCRIPTION
""
timeStamp OBJECT-TYPE
STATUS current
DESCRIPTION
""
testStatus OBJECT-TYPE
STATUS current
DESCRIPTION
""
from OBJECT-TYPE
STATUS current
DESCRIPTION
""
to OBJECT-TYPE
STATUS current
DESCRIPTION
""
errorReason OBJECT-TYPE
STATUS current
DESCRIPTION
""
– 39 – 913-2383-01 Rev A
failReason OBJECT-TYPE
STATUS current
DESCRIPTION
""
pairname OBJECT-TYPE
STATUS current
DESCRIPTION
""
metricName OBJECT-TYPE
STATUS current
DESCRIPTION
""
metricvalue OBJECT-TYPE
STATUS current
DESCRIPTION
""
defaultThresholdType OBJECT-TYPE
STATUS current
DESCRIPTION
""
threshold OBJECT-TYPE
STATUS current
DESCRIPTION
""
metricstatus OBJECT-TYPE
STATUS current
DESCRIPTION
""
913-2383-01 Rev A – 40 –
timeStampProviso OBJECT-TYPE
STATUS current
DESCRIPTION
""
provisoAlarmMessage OBJECT-TYPE
STATUS current
DESCRIPTION
""
testType OBJECT-TYPE
STATUS current
DESCRIPTION
""
summary OBJECT-TYPE
STATUS current
DESCRIPTION
""
trapID OBJECT-TYPE
STATUS current
DESCRIPTION
""
hawkeye-notification NOTIFICATION-TYPE
OBJECTS {
trapID,
summary,
runID,
timeStamp,
testType,
testStatus,
from,
to,
pairname,
metricName,
– 41 – 913-2383-01 Rev A
metricvalue,
defaultThresholdType,
threshold,
metricstatus,
failReason
}
STATUS current
DESCRIPTION
""
::= { hawkeye-notificationprefix 1 }
hawkeye-errornotification NOTIFICATION-TYPE
OBJECTS {
trapID,
summary,
runID,
timeStamp,
testType,
testStatus,
from,
to,
errorReason
}
STATUS current
DESCRIPTION
""
hawkeye-probenotification NOTIFICATION-TYPE
OBJECTS {
probeID,
probeMgtIP,
probeName,
probeStatus,
testAgentName
}
STATUS current
DESCRIPTION
""
hawkeye-provisoalarm NOTIFICATION-TYPE
OBJECTS {
timeStampProviso,
provisoAlarmMessage
}
STATUS current
DESCRIPTION
""
END
913-2383-01 Rev A – 42 –
Associated MIB Descriptors

Associated MIB descriptors can be needed to import MIB. The associated MIB descriptor are available
in the same subdirectory:
/usr/share/snmp/mibs
– 43 – 913-2383-01 Rev A
SOAP Web Services API

Hawkeye solution is web based GUI. Some specific functions have been developed to be available for
third party OSS through specific APIs.
The global API framework is using SOAP web services and allows third party to connect to the Hawkeye
Web services through industry standard APIs.
SOAP, originally defined as Simple Object Access Protocol, is a protocol specification for exchanging
structured information in the implementation of Web Services in computer networks. It relies on
Extensible Markup Language (XML) for its message format.
The following diagram present high level scheme for the SOAP xml implementation.
SOAP XML Server on the Hawkeye is implemented over PHP php_soap generic extension. It is
therefore compatible with any SOAP client and agnostic about the connecting technology.
It is installed and uses the same port as the (Apache) Hawkeye server GUI. The default port is 80, but
if 443 is specified for security for the Hawkeye server, it will listen for incoming requests on port 443.
It publishes WSDL file format for creating SOAP client connector and publishing all available APIs.
For security it is recommended to run SOAP request on https port .
913-2383-01 Rev A – 44 –
Activating SOAP in Hawkeye

In system > Preferences > Advanced Admin section, the following parameters need to be
activated:
SOAP web service API server set to 1 or 2 Advanced Setting: Enable

activation server to be used as SOAP web
services
0- not activated
1- SOAP server function
Enabled (no restriction)
2- SOAP server function
Enabled - IP address restricted
SOAP client IP set to Client IP if option 2 is Advanced Setting: IP

preferred for security configuration (used when SOAP
server IP address restriction is
configured)
Activating SOAP wsdl File

SOAP wsdl file is provided on the following path:
/home/ixia/Hawkeye/WebServer/WebServices/Hawkeye.wsdl
Hence, from client it needs to be called from: https://<serverip>/WebServices/Hawkeye.wsdl
Modification needs to be done in the Hawkeye.wsdl file to get access to the APIs. On Hawkeye server
login as root and edit the following file:
/home/ixia/Hawkeye/WebServer/WebServices/Hawkeye.wsdl
replace the following line:
<soap:address location="http://127.0.0.1:80/WebServices/HawkeyeWebService.php"/> 
with your server access (IP or url) and https instead of http if relevant
Example:
<soap:address
location="https://myHawkeyeServerURL/WebServices/HawkeyeWebService.php"/> 
– 45 – 913-2383-01 Rev A
SOAP API Guide

The complete list of messages available can be found in the following file on the Hawkeye server:
/home/ixia/Hawkeye/WebServer/WebServices/Hawkeye.wsdl. The following are the list of
available API in Hawkeye.
addGroupAndTestTypesRequest
This is used to add a new group/ update an existing group into Hawkeye.
Input:
Name: string - the name of the group
Comment: string - an optional comment
allowedtestypesStringArray: string - comma-separated string with the allowed test types ids
allowedprobesStringArray: string - comma-separated string with the allowed probes ids
<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:Hawkeye">
<x:Header/>
<x:Body>
<urn:addGroupAndTestTypes>
<urn:Name>?</urn:Login>
<urn:Comment>?</urn:FirstName>
<urn:allowedtestypesStringArray>?</urn:LastName>
<urn:allowedprobesStringArray>?</urn:email>
</urn:addGroupAndTestTypes>
</x:Body>
addGroupAndTestTypesResponse
Output:
integer - the id of the group added
<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="urn:Hawkeye" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-
ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-
ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:addGroupAndTestTypesResponse>
<return xsi:type="xsd:string">2</return>
</ns1:addGroupAndTestTypesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addProbe
913-2383-01 Rev A – 46 –
This is used to add a new Probe into Hawkeye. This is only relevant for Manual probes and not required
for any Automatic probes (which we recommend).
Parameters
probename - string - the name for the probe
probeip - string - the IP for the probe test interface
probemgmtip- string - the IP for the probe management interface
probegroup- string - the IP for the probe management interface
probelocation- string - the IP for the probe management interface
probetypeid - integer - the id for the probe you are adding
available id are
"2";"Software"
"6";"xr2000"
"7";"xr2000_vm"
"8";"xr_pi"
probeAvailability- integer -
0 for for both from and to
1 for from only
2 for to only
AvailableForMesh - integer - 0 for not available, 1 for not available
<x:Header/>
<x:Body>
<urn:addProbe>
<urn:probename>?</urn:probename>
<urn:probeip>?</urn:probeip>
<urn:probemgmtip>?</urn:probemgmtip>
<urn:probegroup>?</urn:probegroup>
<urn:probelocation>?</urn:probelocation>
<urn:probetypeid>?</urn:probetypeid>
<urn:probeAvailability>?</urn:probeAvailability>
<urn:AvailableForMesh>?</urn:AvailableForMesh>
</urn:addProbe>
</x:Body>
output
0: failed to add
– 47 – 913-2383-01 Rev A
1: added
addUser
This is used to add a new user/ update an existing user into Hawkeye.
Input:
Login: string - the user login
FirstName: string - user's first name
LastName: string - user's last name
email: string - user's email
GroupID: string - the group ID
memberlevel: integer - the member level
Password: user's password
IsActive: user's status
<x:Header/>
<x:Body>
<urn:addUser>
<urn:Login>?</urn:Login>
<urn:FirstName>?</urn:FirstName>
<urn:LastName>?</urn:LastName>
<urn:email>?</urn:email>
<urn:GroupID>?</urn:GroupID>
<urn:memberlevel>?</urn:memberlevel>
<urn:IsActive>?</urn:IsActive>
</urn:addUser>
</x:Body>
addUserResponse
Output:
API returns the id (integer) of the user added

<SOAP-ENV:Body>
<ns1:addUserResponse>
913-2383-01 Rev A – 48 –
</ns1:addUserResponse>
</SOAP-ENV:Body>
cancelTestExecution
This is used to pause/remove a test execution.
Input:
ID: string - the test execution ID
Pause: 0 - pause , 1 - remove the test execution
<x:Header/>
<x:Body>
<urn:cancelTestExecution>
<urn:ID>?</urn:ID>
<urn:Pause>?</urn:Pause>
</urn:cancelTestExecution>
</x:Body>
cancelTestExecutionResponse
Output:
integer - 1 if operation finished successfully, 0 otherwise

<SOAP-ENV:Body>
<ns1:cancelTestExecutionResponse>
</ns1:cancelTestExecutionResponse>
</SOAP-ENV:Body>
checkTestExecutionResultStatus
This is used to find out about the test execution based on a test execution ID that was created with API
or manually on the UI.
This returns the last TDR ID found into the database for this execution ID
Parameters:
execID: corresponds to test execution ID
– 49 – 913-2383-01 Rev A
<x:Header/>
<x:Body>
<urn:checkTestExecutionResultStatus>
<urn:execID>?</urn:execID>
</urn:checkTestExecutionResultStatus>
</x:Body>
</x:Envelope>
output:
0: no test data record found
>0: latest Test data record ID found

<SOAP-ENV:Body>
<ns1:checkTestExecutionResultStatusResponse>
</ns1:checkTestExecutionResultStatusResponse>
</SOAP-ENV:Body>
collectTestExecutionResultRange
This api allows to search results for a specific test execution ID and collects all the information on kpis
for a number of test results in history - limited to 1000 test results. Output is in json
Parameters:
testExecID: corresponds to test execution ID for which to run the search
NumberofResults: number of results to look for - results will provided from most recent to least recent.
The limit for the number of results in time interval is 1000 - an error will be returned for higher values.
For latest results in the interval pick 1 for this value.
fromDate: start date of interval - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15) -
use "Start" for looking into any results in the past
toDate: end date of interval - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15) - .
Use "Now" for current date.
913-2383-01 Rev A – 50 –
<x:Header/>
<x:Body>
<urn:collectTestExecutionResultRange>
<urn:testExecID>10</urn:testExecID>
<urn:NumberofResults>10</urn:NumberofResults>
<urn:fromDate>2010-01-01 00:00:00</urn:fromDate>
<urn:toDate>Now</urn:toDate>
</urn:collectTestExecutionResultRange>
</x:Body>
</x:Envelope>
output: a result in json format with fields populated describing TDR, result (one line per metric)
example:
[{"ID":"14547914077197","Value":"2053.64","METRIC":"Download Rate (kbps)","PAIR_

NAME":"HTTP Server Test","NODEFROM_NAME":"xrpi2Paris","NODETO_
NAME":"www.google.com","TIMESTAMP":"2016-02-06
21:43:27","STATUS":"Passed","REASON_CAUSE":"","TDR_comment":"DownloadFullPage: 1
ip_version: ipv4 UseProxy: 0 ProxyAddress: ","MODULE":"RealService","TESTTYPE_
ID":"5140","TESTTYPE":"HTTP Server Test","MESHID":"0","MESHNAME":"","NODEFROM_
PROBEID":"51150","NODETO_PROBEID":"0","NODEFROM_IP":"10.204.20.27","NODETO_
IP":"","NODEFROM_MGMTIP":"10.204.20.27","NODETO_MGMTIP":"","NODEFROM_
LOCATION":"TEST","NODETO_LOCATION":"","NODEFROM_PROBE_GROUP":"","NODETO_PROBE_
GROUP":"","EXECUTION_USER_ID":"1","EXECUTION_USER_LOGIN":"sysadmin","TEST_
DURATION":"0","TESTEXEC_ID":"23552","TESTEXEC_STRING":""},
{"ID":"14547914077197","Value":"261","METRIC":"Download Time (msec)","PAIR_
{"ID":"14547914077197","Value":"67","METRIC":"Files Size (kB)","PAIR_NAME":"HTTP
Server Test","NODEFROM_NAME":"xrpi2Paris","NODETO_
– 51 – 913-2383-01 Rev A
{"ID":"14547914077197","Value":"6","METRIC":"Number Of Files","PAIR_NAME":"HTTP
{"ID":"14547914077197","Value":"100.14","METRIC":"Time to First Byte Avg
(ms)","PAIR_NAME":"HTTP Server Test","NODEFROM_NAME":"xrpi2Paris","NODETO_
{"ID":"14547914077197","Value":"206","METRIC":"Time to First Byte Max
{"ID":"14547736316850","Value":"755.99","METRIC":"Download Rate (kbps)","PAIR_
913-2383-01 Rev A – 52 –
{"ID":"14547736316850","Value":"709","METRIC":"Download Time (msec)","PAIR_

{"ID":"14547736316850","Value":"67","METRIC":"Files Size (kB)","PAIR_NAME":"HTTP
{"ID":"14547736316850","Value":"6","METRIC":"Number Of Files","PAIR_NAME":"HTTP
{"ID":"14547736316850","Value":"314.57","METRIC":"Time to First Byte Avg
{"ID":"14547736316850","Value":"364","METRIC":"Time to First Byte Max
– 53 – 913-2383-01 Rev A

DURATION":"0","TESTEXEC_ID":"23552","TESTEXEC_STRING":""}]
return 0 if no results are found , and ERROR with indication in case of errors in input parameters
collectAverageKPIresult
This function will allow to return an array of results averaged over time for specific filters set within the
function
fromDate: date to gather data from - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01
20:07:15)
fromDate: date to gather data to- format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15)
fromFilterType: type of filter to apply first
("MODULE","TESTTYPE_ID","TESTTYPE","MESHID","MESHNAME","NODEFROM_PROBEID","NODETO_
PROBEID","STATUS","NODEFROM_IP","NODETO_IP","NODEFROM_MGMTIP","NODETO_
MGMTIP","NODEFROM_NAME","NODETO_NAME","NODEFROM_LOCATION","NODETO_
LOCATION","NODEFROM_PROBE_GROUP","NODETO_PROBE_GROUP","EXECUTION_USER_
ID","EXECUTION_USER_LOGIN","TDR_comment","TEST_DURATION","TESTEXEC_ID","TESTEXEC_
STRING")
fromFilter: value of filter - % is wild card (example "node1" or "node%")
toFilterType: type of filter to apply second criteria
("MODULE","TESTTYPE_ID","TESTTYPE","MESHID","MESHNAME","NODEFROM_PROBEID","NODETO_
PROBEID","STATUS","NODEFROM_IP","NODETO_IP","NODEFROM_MGMTIP","NODETO_
MGMTIP","NODEFROM_NAME","NODETO_NAME","NODEFROM_LOCATION","NODETO_
LOCATION","NODEFROM_PROBE_GROUP","NODETO_PROBE_GROUP","EXECUTION_USER_
ID","EXECUTION_USER_LOGIN","TDR_comment","TEST_DURATION","TESTEXEC_ID","TESTEXEC_
STRING")
toFilter: value of filter - % is wild card (example "node1" or "node%")
TestType: filter for test type - leave to blank for not filtering-value of filter - % is wild card
available values
"Adaptive Video"
"Adaptive video with network quality"
913-2383-01 Rev A – 54 –
"BitTorrent"
"COS line qualification"
"DNS Response Time"
"DNS Test"
"DropBox Download"
"DropBox Upload"
"Email"
"Exchange_traffic"
"Flash RTMP"
"FTP Download"
"FTP Multistream Download"
"FTP Response Time"
"HTTP response time"
"HTTP Server Test"
"HTTP Server Test - Advanced"
"HTTP Test"
"HTTPS Test"
"ICMP performance"
"ICMP Test"
"IGMP Test"
"Skype4B Traffic"
"Skype4B Traffic from->to"
"Multicast Video over RTP"
"Netflix"
"Network KPI"
"Network KPI 3 COS"
"Network KPI Advanced"
"Network KPI bidirectionnal"
"Network KPI Low Bandwidth"
"Network KPI to->from"
– 55 – 913-2383-01 Rev A
"POP3 Response Time"
"SIP Response Time"
"SMTP Response Time"
"TCP ping"
"TCP Response Time"
"TCP Throughput Advanced"
"TCP Throughput bidirectional"
"TCP Throughput from->to 1 stream"
"TCP Throughput from->to N streams"
"TCP Throughput Optimized Window size"
"TCP Throughput to->from 1 stream"
"TCP Throughput to->from N streams"
"Traceroute"
"Traffic Mix - HTTP - Video - Voice"
"UDP ping"
"UDP Throughput Advanced"
"UDP Throughput bidirectional"
"UDP Throughput from->to"
"UDP Throughput from->to - 4 COS"
"UDP Throughput to->from"
"Video Stream"
"Voice bidirectional"
"Voice from->to"
"Voice N pairs - UDP Data bidirectional"
"Voice N Pairs bidirectional"
"Voice N Pairs Unidirectional"
"Wi-Fi Connect"
"Wi-Fi Inspect"
"Youtube"
"Youtube Test"
913-2383-01 Rev A – 56 –
PairName: available for specific pair name - leave to blank for not filtering-value of filter - % is wild
card
available values
"KPI from->to"
"KPI to->from"
"TCP from->to N pairs"
"TCP from->to 1 pair"
"TCP to->from 1 pair"
"TCP to->from N pairs"
"TCP from->to"
"TCP to->from"
"UDP from->to"
"UDP to->from"
"Voice from->to"
"Voice to->from"
"SG0 COS"
"SG1 COS"
"SG2 COS"
"SG3 COS"
"SG4 COS"
"SG5 COS"
"SG6 COS"
"Network KPI from->to"
"Stream"
"Audio Stream"
"Video Stream"
"Video from->to"
"Audio RTP from->to"
– 57 – 913-2383-01 Rev A
"Audio RTP to->from"
"Video RTP from->to"
"Video RTP to->from"
"DNS"
"COS 1"
"COS 2"
"COS 3"
"Voice from->to AF31"
"Voice from->to AF41"
"Voice from->to Best Effort"
"Voice from->to EF"
"Voice to->from AF31"
"Voice to->from AF41"
"Voice to->from Best Effort"
"Voice to->from EF"
"Chassis Port-to-Port Traffic"
"TCP from->to AF11"
"TCP from->to AF21"
"TCP from->to AF31"
"TCP from->to HIGH"
"TCP from->to LOW"
"TCP from->to MEDIUM"
"Voice"
"Specific Test from->to"
"UDP transaction"
"TCP transaction"
"Exchange rcv"
"Exchange send"
"HTTP from->to"
"Voice from->to G711"
913-2383-01 Rev A – 58 –
"Voice to->from G711"
"HTTP Response Time"
"HTTPS Response Time"
"POP3 Response"
"SMTP Response"
"FTP Response Time"
"SIP Response Time"
"LDAP Response Time - Enterprise"
"DNS Response Time"
"TCP Response Time"
"UDP from->to COS1"
"UDP from->to COS2"
"UDP from->to COS3"
"UDP from->to COS4"
"UDP from->to COS5"
"UDP from->to COS6"
Metric: selected metric to filter on - can be left blank for not filtering (not recommended)-value of filter
- % is wild card
List of available metrics
"Avg Video Playback Rate (bps)"
"Avg Video Prebuffering Duration (ms)"
"Jitter Buffer Full Count"
"Jitter Buffer Full Duration (ms)"
"Throughput from->to (kbps)"
"Video Playback Downshifts"
"Video Playback Upshifts"
"Video Quality Segments - High"
"Video Quality Segments - Low"
"Video Quality Segments - Medium"
– 59 – 913-2383-01 Rev A
"Video Quality Segments - Very High"
"Video Quality Segments - Very Low"
"Video Stopped Count"
"Video Stopped Duration (ms)"
"Datagrams Out of Order"
"Delay (ms)"
"Delay Max (ms)"
"Delay Min (ms)"
"Jitter (ms)"
"Jitter Max (ms)"
"Jitter Min (ms)"
"Loss"
"Max loss burst"
"Throughput Video (kbps)"
"Total Bytes Lost"
"Video MDI Delay Factor"
"Video MDI Media Loss Rate"
"Throughput Audio (kbps)"
"Max Jitter (ms)"
"Throughput (kbps)"
"MOS"
"MOS Max"
"MOS Min"
"Voice Throughput (kbps)"
"Throughput to->from (kbps)"
"Throughput to->from Max (kbps)"
"Throughput to->from Min (kbps)"
"Throughput UDP from->to (kbps)"
"Throughput UDP from->to Max (kbps)"
"Throughput UDP from->to Min (kbps)"
913-2383-01 Rev A – 60 –
"Throughput from->to Max (kbps)"
"Throughput from->to Min (kbps)"
"Throughput UDP to->from (kbps)"
"Throughput UDP to->from Max (kbps)"
"Throughput UDP to->from Min (kbps)"
"HTTP Throughput (kbps)"
"HTTP Transaction per sec"
"Bytes Rcvd by Probe from"
"Bytes Sent by Probe From"
"Response Time (sec)"
"Throughput Max (kbps)"
"Throughput Min (kbps)"
"Transaction per sec"
"Response Time (ms)"
"Transaction Rate (per sec)"
"Number of packets received"
"Number of packets sent"
"Download Rate (kbps)"
"Download Time (ms)"
"Files Size (kB)"
"Number Of Files"
"Time to First Byte Avg (ms)"
"Torrent Download Rate (kbps)"
"DNS Availability"
"DNS Response Time (ms)"
"Availability"
"Jitter (ms)"
"Jitter Max (ms)"
"Jitter standard deviation"
"Packet loss"
– 61 – 913-2383-01 Rev A
"Round trip time avg (ms)"
"Round trip time max (ms)"
"Round trip time min (ms)"
"Standard deviation (ms)"
"FTP Download Rate (kbps)"
"Video Download Rate (kbps)"
"Video Server - DNS response time (ms)"
"Video Server - ICMP jitter (ms)"
"Video Server - ICMP loss rate"
"Video Server - Intial buffering time (ms)"
"Video Server - Time to first video Byte (ms)"
"Video Server - Total time spent buffering (ms)"
"Video Server - Video rebuffering occurences"
"Authentication Availability"
"Response Time (sec)"
"Total Accepted Authentications"
"Total Denied Authentications"
"Total Lost Authentications"
"Speedtest Round Trip Delay (ms)"
"Speedtest TCP Downstream (kbps)"
"Speedtest TCP Upstream (kbps)"
"Frame delay (ms)"
"Frame Loss"
"TCP Packet loss"
"TCP Round trip time avg (ms)"
"TCP Round trip time max (ms)"
"TCP Round trip time min (ms)"
"Application Latency (ms)"
"Bytes from server"
"TCP Latency (ms)"
913-2383-01 Rev A – 62 –
"Total http download time (ms)"
"File Size (kb)"
"PADI packets"
"PADO packets"
"PPPOE response time (ms)"
"dhcp packets received"
"dhcp packets sent"
"DHCP response time (ms)"
"Average Packet Length"
"Interpacket arrival average (ms)"
"Interpacket arrival max (ms)"
"Interpacket arrival min (ms)"
"Interpacket arrival standard deviation (ms)"
"join delay (ms)"
"join latency (ms)"
"leave delay (ms)"
"leave latency (ms)"
"Loss rate"
"Maximum Loss Burst"
"Number Of flows"
"source throughput (kbps)"
"Throughput average (kbps)"
"Total kBytes Received"
"Total Packets Lost"
"Total Packets Received"
"Total stream duration (ms)"
"ts continuity error"
"ts duplicates"
"ts loss rate"
"ts number of segments"
– 63 – 913-2383-01 Rev A
"Interpacket gap avg (ms)"
"Interpacket gap max (ms)"
"Interpacket gap min (ms)"
"Kbytes received total"
"Loss rate avg"
"Loss rate max"
"Number of 1-DESCRIBE Message Sent"
"Number of 1-DESCRIBE Response received"
"Number of 2-SETUP Message Sent"
"Number of 2-SETUP Response received"
"Number of 3-PLAY Message Sent"
"Number of 3-PLAY Response received"
"Number of 4-TEARDOWN Message Sent"
"Number of 4-TEARDOWN Response received"
"Number of packets lost"
"Number of packets received"
"Number of RTP streams"
"Throughput avg (kbps)"
"FTP Upload Rate (kbps)"
"Average MDI DF"
"Duplicated packets"
"Max Loss Burst"
"MDI Media Loss Rate"
"Number of Bytes received"
"throughput (kbps)"
"TVQM average absolute MOS Video"
"TVQM average MOS Audio"
"TVQM average MOS Video"
"TVQM average relative MOS Video"
"TVQM average Video bandwidth"
913-2383-01 Rev A – 64 –
"TVQM frame rate"
"TVQM packets discarded"
"TVQM packets received"
"TVQM peak Video bandwidth"
"Video Codec"
"UDP Packet loss"
"UDP Round trip time avg (ms)"
"UDP Round trip time max (ms)"
"UDP Round trip time min (ms)"
"ICMP loss"
"ICMP throughput (kbps)"
"1-Association time (ms)"
"2-Authentication time (ms)"
"3-Connect time (ms)"
"4-DHCP Handshake Time (ms)"
"Association Attempts"
"ICMP Packet loss"
"ICMP Round Trip avg"
"Signal Strength (%)"
"Total Connect Time (ms)"
"Wi-Fi Signal Level (dBm)"
"Connectivity Status"
<x:Header/>
<x:Body>
<urn:collectAverageKPIresult>
<urn:fromDate>2014-02-01 20:07:15</urn:fromDate>
<urn:toDate>2016-02-01 20:07:15</urn:toDate>
<urn:fromFilterType></urn:fromFilterType>
<urn:fromFilter></urn:fromFilter>
<urn:toFilterType></urn:toFilterType>
<urn:toFilter></urn:toFilter>
<urn:TestType></urn:TestType>
– 65 – 913-2383-01 Rev A
<urn:PairName></urn:PairName>
<urn:Metric></urn:Metric>
</urn:collectAverageKPIresult>
</x:Body>
</x:Envelope>
output is an array with metrics
example
ErrorCode,Passed,Failed,myavgvalue,myvaluemin,myvaluemax,StandardDeviation,totalcount,thresho
ld_min,threshold_max,threshold_type
0,1061481,287788,3.10,0.00,1280.00,5.97,1349269,5,8,0.0000

<SOAP-ENV:Body>
<ns1:collectAverageKPIresultResponse>
<return
xsi:type="xsd:string">ErrorCode,Passed,Failed,myavgvalue,myvaluemin,myvaluemax,St
andardDeviation,totalcount,threshold_min,threshold_max,threshold_type
0,1061481,287788,3.10,0.00,1280.00,5.97,1349269,5,8,0.0000</return>
</ns1:collectAverageKPIresultResponse>
</SOAP-ENV:Body>
collectKPI_result
Use this function to collect the KPI information from a specific test result based on ID
Parameter
tdrID: ID of the test result to collect information from
<x:Header/>
<x:Body>
<urn:collectKPI_result>
<urn:tdrID>1666360</urn:tdrID>
</urn:collectKPI_result>
</x:Body>
</x:Envelope>
Result:
0 if no idea is found
913-2383-01 Rev A – 66 –
string with full set of metrics information if it is available:
Example
TDR_ID METRIC PAIR_ID PAIR_NAME STATUS VALUE THRESHOLD THRESHOLDTYPE
"1666360" "Datagrams Out of Order" "15152" "KPI from->to" "Passed" "0" "1" "0"
"1666360" "Delay (ms)" "15152" "KPI from->to" "Passed" "10.43" "100" "0"
"1666360" "Jitter (ms)" "15152" "KPI from->to" "Failed" "9.57" "5" "0"
"1666360" "Jitter Max (ms)" "15152" "KPI from->to" "Failed" "15" "5" "0"
"1666360" "Loss" "15152" "KPI from->to" "Passed" "0" "0.2" "0"
"1666360" "Max loss burst" "15152" "KPI from->to" "Passed" "0" "2" "0"
"1666360" "MOS" "15152" "KPI from->to" "Passed" "4.24" "3.7" "1"

<SOAP-ENV:Body>
<ns1:collectKPI_resultResponse>
<return xsi:type="xsd:string">TDR_ID METRIC PAIR_ID PAIR_NAME STATUS VALUE
THRESHOLD THRESHOLDTYPE
"1666360" "Datagrams Out of Order" "15152" "KPI from->to" "Passed" "0" "1" "0"
"1666360" "Delay (ms)" "15152" "KPI from->to" "Passed" "10.43" "100" "0"
"1666360" "Jitter (ms)" "15152" "KPI from->to" "Failed" "9.57" "5" "0"
"1666360" "Jitter Max (ms)" "15152" "KPI from->to" "Failed" "15" "5" "0"
"1666360" "Loss" "15152" "KPI from->to" "Passed" "0" "0.2" "0"
"1666360" "Max loss burst" "15152" "KPI from->to" "Passed" "0" "2" "0"
"1666360" "MOS" "15152" "KPI from->to" "Passed" "4.24" "3.7" "1"
</return>
</ns1:collectKPI_resultResponse>
</SOAP-ENV:Body>
collectTDR_result
This will collect test data result information about test ID
Parameter
tdrID: ID of the test result to collect information from
<x:Header/>
– 67 – 913-2383-01 Rev A
<x:Body>
<urn:collectTDR_result>
<urn:tdrID>1666360</urn:tdrID>
</urn:collectTDR_result>
</x:Body>
</x:Envelope>
Response contains array with TDR content
example:
ID NODEFROM_NAME NODETO_NAME TIMESTAMP STATUS REASON_CAUSE TDR_comment MODULE

TESTTYPE_ID TESTTYPE MESHID MESHNAME NODEFROM_PROBEID NODETO_PROBEID NODEFROM_IP
NODETO_IP NODEFROM_MGMTIP NODETO_MGMTIP NODEFROM_LOCATION NODETO_LOCATION
NODEFROM_PROBE_GROUP NODETO_PROBE_GROUP EXECUTION_USER_ID EXECUTION_USER_LOGIN
TEST_DURATION TESTEXEC_ID TESTEXEC_STRING
"1666360" "AWSprivate2" "AWSprivate4" "2016-11-16 16:58:56" "Failed" " Threshold failed on KPI
from->to Jitter (ms)
Threshold failed on KPI from->to Jitter Max (ms)
" "N2N" "5129" "Network KPI" "0" "8" "9" "ip-10-1-1-139" "ip-10-1-1-143" "ip-10-1-1-139" "ip-10-1-1-
143" "1" "sysadmin" "15" "74" "webservice"

<SOAP-ENV:Body>
<ns1:collectTDR_resultResponse>
<return xsi:type="xsd:string">ID NODEFROM_NAME NODETO_NAME TIMESTAMP STATUS
REASON_CAUSE TDR_comment MODULE TESTTYPE_ID TESTTYPE MESHID MESHNAME NODEFROM_
PROBEID NODETO_PROBEID NODEFROM_IP NODETO_IP NODEFROM_MGMTIP NODETO_MGMTIP
NODEFROM_LOCATION NODETO_LOCATION NODEFROM_PROBE_GROUP NODETO_PROBE_GROUP
EXECUTION_USER_ID EXECUTION_USER_LOGIN TEST_DURATION TESTEXEC_ID TESTEXEC_STRING
"1666360" "AWSprivate2" "AWSprivate4" "2016-11-16 16:58:56" "Failed" " Threshold
failed on KPI from->to Jitter (ms)
Threshold failed on KPI from->to Jitter Max (ms)
" "N2N" "5129" "Network KPI" "0" "8" "9" "ip-10-1-1-139" "ip-10-1-1-143" "ip-10-
1-1-139" "ip-10-1-1-143" "1" "sysadmin" "15" "74" "webservice"
</return>
</ns1:collectTDR_resultResponse>
</SOAP-ENV:Body>
configureN2NListExecution
Use this function to setup a new test for Node to Node (prefer to configure TestExecution)
913-2383-01 Rev A – 68 –
If using list of probes, you can create one to one or many to many combinations of tests
Parameters:
TestType : test type to trigger the test with
Includes
"Network KPI"
"Adapative Video"
"Flash RTMP"
"Netflix"
"Youtube"
"Skype4B Traffic"
"Video Stream"
– 69 – 913-2383-01 Rev A
"Network KPI 3 COS"
"Voice from->to"
"Exchange_traffic"
"HTTP Test"
"HTTPS Test"
"FTP Response Time"
"SIP Response Time"
"DNS Response Time"
"TCP Response Time"
NodeFrom: node List to use to start the test
Use commas between probe names
the probe needs to have an existing and active probe configured into db otherwise will be ignored
Example : probe1,probe2
Nodeto: node List to use to start the test
OneToOne: value is either 0 (many to many) or 1 (onetoone)
if using the list:
913-2383-01 Rev A – 70 –
nodefrom: probe1,probe2
nodeto: probe3,probe4
the test that will be scheduled will look like
value 0: many to many
probe1->probe3
probe1->probe4
probe2->probe3
probe2->probe4
value 1: one to one
probe1->probe3
probe2->probe4
Frequency: frequency in minutes you want to run the test with
0 means one shot
EnforceSchedule: set the enforce scheduling to 0 (not enforce) or 1 (enforce)
mystartdate: schedule start date - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15)
Note: leave empty for starting now or for immediate one shot
myenddate: schedule end date - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15)
Note: leave empty for never ending schedule or one shot
arrayOptionsNameString: define the names of the options for the test
arrayOptionsValueString: define the values of the options for the test
Following table describe the parameter. for each test type, the options need to be put in the exact
order as detailed in the table below.
– 71 – 913-2383-01 Rev A
IF there is an associated pair (pair_id is not null), the name must be entered with following format in
API:
ParameterName|SPECIFICPAIR|pair_id
If the pair_id is 0 then ParameterName is sufficient
arrayOptionsValueString will contain the exact value
Example for UDP throughput bidirectional test:
"UDP Throughput bidirectional";"packetsize";"Packet Size";"0";NULL
"UDP Throughput bidirectional";"QOS";"DSCP Setting";"0";NULL
"UDP Throughput bidirectional";"bitrate";"Throughput from->to (kbps)";"15161";"UDP from->to"
"UDP Throughput bidirectional";"bitrate";"Throughput to->from (kbps)";"15162";"UDP to->from"
arrayOptionsNameString
packetsize,QOS,bitrate|SPECIFICPAIR|15161,bitrate|SPECIFICPAIR|15162
arrayOptionsValueString
1400,EF,20000,40000
will set packetsize to 1400, QOS to EF, UDP from->to 20000kbps, UDP to->from to 40000kbps
"Test Name";"ParameterName";"Display Name";"assodciated pair_id";"Associated pair Name"
"Adapative Video";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Adapative Video";"BitRatesList";"Bitrates List (Mbps)";"6005";"Stream"
"Adapative Video";"QOS";"DSCP Setting";"6005";"Stream"
"Adaptive video with network quality";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Adaptive video with network quality";"QOS";"DSCP Setting";"0";NULL
"Adaptive video with network quality";"BitRatesList";"Bitrates List (Mbps)";"6007";"Stream"
"COS line qualification";"filesize";"File Size (bytes)";"0";NULL
"COS line qualification";"DestinationPort";"Destination Port";"12111";"TCP from->to HIGH"
"COS line qualification";"QOS";"DSCP Setting";"12111";"TCP from->to HIGH"
"COS line qualification";"DestinationPort";"Destination Port";"12112";"TCP from->to MEDIUM"
"COS line qualification";"QOS";"DSCP Setting";"12112";"TCP from->to MEDIUM"
"COS line qualification";"DestinationPort";"Destination Port";"12113";"TCP from->to LOW"
913-2383-01 Rev A – 72 –
"COS line qualification";"QOS";"DSCP Setting";"12113";"TCP from->to LOW"
"COS line qualification";"bitrate";"Total bitrate (kbps)";"12114";"Voice"
"COS line qualification";"DestinationPort";"Destination Port";"12114";"Voice"
"COS line qualification";"QOS";"DSCP Setting";"12114";"Voice"
"DNS Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"DNS Response Time";"testscript";"Test Script";"0";NULL
"Exchange_traffic";"numberofpairs";"Number of Users";"0";NULL
"Exchange_traffic";"bitrate";"Total bitrate (kbps)";"31014";"Exchange send"
"Exchange_traffic";"filesize";"email size (kbytes)";"31014";"Exchange send"
"Exchange_traffic";"bitrate";"Total bitrate (kbps)";"31015";"Exchange rcv"
"Exchange_traffic";"filesize";"email size (kbytes)";"31015";"Exchange rcv"
"Flash RTMP";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Flash RTMP";"QOS";"DSCP Setting";"0";NULL
"Flash RTMP";"BitRatesList";"Bitrates List (Mbps)";"6006";"Stream"
"FTP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"FTP Response Time";"testscript";"Test Script";"0";NULL
"HTTP Test";"bitrate";"Total bitrate (kbps)";"0";NULL
"HTTP Test";"testscript";"Test Script";"0";NULL
"HTTPS Test";"bitrate";"Total bitrate (kbps)";"0";NULL
"HTTPS Test";"testscript";"Test Script";"0";NULL
"Skype4B Traffic";"numberofpairs";"Number Of Pairs";"0";NULL
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7005";"Audio RTP from->to"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7005";"Audio RTP from->to"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7006";"Audio RTP to->from"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7006";"Audio RTP to->from"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7007";"Video RTP from->to"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7007";"Video RTP from->to"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7008";"Video RTP to->from"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7008";"Video RTP to->from"
"Skype4B Traffic from->to";"numberofpairs";"Number Of Pairs";"0";NULL
– 73 – 913-2383-01 Rev A
"Skype4B Traffic from->to";"bitrate";"Total bitrate (kbps)";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"packetsize";"packet size (bytes)";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"QOS";"DSCP Setting";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"bitrate";"Total bitrate (kbps)";"7010";"Video RTP from->to"
"Skype4B Traffic from->to";"packetsize";"packet size (bytes)";"7010";"Video RTP from->to"
"Skype4B Traffic from->to";"QOS";"DSCP Setting";"7010";"Video RTP from->to"
"Multicast Video over RTP";"bitrate";"Total bitrate (kbps)";"0";NULL
"Multicast Video over RTP";"QOS";"DSCP Setting";"0";NULL
"Multicast Video over RTP";"MulticastAddressAndPort";"Multicast Address:Port";"6010";"Video from-

>to"
"Netflix";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Netflix";"QOS";"DSCP Setting";"0";NULL
"Netflix";"BitRatesList";"Video Rates";"15202";"Video Stream"
"Netflix";"BitRatesList";"Audio Rates";"15203";"Audio Stream"
"Network KPI";"QOS";"DSCP Setting";"0";NULL
"Network KPI 3 COS";"QOS";"DSCP Setting";"17459";"COS 1"
"Network KPI Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
"Network KPI Advanced";"packetsize";"packet size (bytes)";"0";NULL
"Network KPI Advanced";"QOS";"DSCP Setting";"0";NULL
"Network KPI bidirectionnal";"QOS";"DSCP Setting";"0";NULL
"Network KPI to->from";"QOS";"DSCP Setting";"0";NULL
"POP3 Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"POP3 Response Time";"testscript";"Test Script";"0";NULL
"SIP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"SIP Response Time";"testscript";"Test Script";"0";NULL
"SMTP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"SMTP Response Time";"testscript";"Test Script";"0";NULL
"TCP Response Time";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
913-2383-01 Rev A – 74 –
"TCP Throughput Advanced";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Advanced";"filesize";"File Size (bytes)";"0";NULL
"TCP Throughput Advanced";"packetsize";"Send buffer Size";"0";NULL
"TCP Throughput Advanced";"DestinationPort";"Destination Port";"0";NULL
"TCP Throughput Advanced";"SourcePort";"Source Port";"0";NULL
"TCP Throughput Advanced";"sendsocketbuffer_e1";"send socket buffer e1";"0";NULL
"TCP Throughput Advanced";"sendsocketbuffer_e2";"send socketbuffer e2";"0";NULL
"TCP Throughput Advanced";"receivesocketbuffer_e1";"receive socketbuffer e1";"0";NULL
"TCP Throughput bidirectional";"bitrate";"Throughput from->to (kbps)";"15157";"TCP from->to"
"TCP Throughput bidirectional";"bitrate";"Throughput to->from (kbps)";"15158";"TCP to->from"
"TCP Throughput from->to 1 stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput from->to 1 stream";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput from->to N streams";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput from->to N streams";"numberofpairs";"Number Of Pairs";"0";NULL
"TCP Throughput from->to N streams";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Optimized Window size";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput Optimized Window size";"ExpectedLineDelay";"Expected Line One Way Delay

(ms)";"0";NULL
"TCP Throughput Optimized Window size";"filesize";"File Size (bytes)";"0";NULL
"TCP Throughput Optimized Window size";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput to->from 1 stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput to->from 1 stream";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput to->from N streams";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput to->from N streams";"numberofpairs";"Number Of Pairs";"0";NULL
"TCP Throughput to->from N streams";"QOS";"DSCP Setting";"0";NULL
"Traffic Mix - HTTP - Video - Voice";"bitrate";"Total bitrate (kbps)";"40013";"Video from->to"
"Traffic Mix - HTTP - Video - Voice";"bitrate";"Total bitrate (kbps)";"40014";"HTTP from->to"
"UDP Throughput Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput Advanced";"QOS";"DSCP Setting";"0";NULL
– 75 – 913-2383-01 Rev A
"UDP Throughput Advanced";"filesize";"File Size (bytes)";"0";NULL
"UDP Throughput Advanced";"packetsize";"Send buffer Size";"0";NULL
"UDP Throughput Advanced";"DestinationPort";"Destination Port";"0";NULL
"UDP Throughput Advanced";"SourcePort";"Source Port";"0";NULL
"UDP Throughput from->to";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput from->to";"packetsize";"Packet Size";"0";NULL
"UDP Throughput from->to";"QOS";"DSCP Setting";"0";NULL
"UDP Throughput from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83001";"UDP from->to COS1"
"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83001";"UDP from->to COS1"
"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83001";"UDP from->to COS1"
"UDP Throughput to->from";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput to->from";"packetsize";"Packet Size";"0";NULL
"UDP Throughput to->from";"QOS";"DSCP Setting";"0";NULL
"Video Stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"Video Stream";"QOS";"DSCP Setting";"0";NULL
"Voice bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice bidirectional";"QOS";"DSCP Setting";"0";NULL
913-2383-01 Rev A – 76 –
"Voice from->to";"voicecodec";"Voice Codec";"0";NULL
"Voice from->to";"QOS";"DSCP Setting";"0";NULL
"Voice N pairs - UDP Data bidirectional";"bitrate";"Total bitrate (kbps)";"0";NULL
"Voice N pairs - UDP Data bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N pairs - UDP Data bidirectional";"packetsize";"Packet Size";"0";NULL
"Voice N pairs - UDP Data bidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N Pairs bidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs bidirectional";"QOS";"DSCP Setting";"0";NULL
"Voice N Pairs Unidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N Pairs Unidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs Unidirectional";"QOS";"DSCP Setting";"0";NULL
"Youtube";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Youtube";"QOS";"DSCP Setting";"0";NULL
"Youtube";"BitRatesList";"Video Rates";"15204";"Video Stream"
thresholdArrayString sets specific threshold parameters - leave empty to use default threashold
settings
AlarmType:0 -no alarm
1-email
2-snmp
3- email And snmp
FailedAlarm-
0 - do not raise alarm on fail
1 - do raise alarm on fail
ErrorAlarm-
0 - do not raise alarm on error
– 77 – 913-2383-01 Rev A
1 - do raise alarm on error
StatusChangeAlarm-
0 - do not raise alarm on statuschange
1 - do raise alarm on statuschange
EmailAddress - string - email address so to send email alarm to
TESTEXEC_STRING: string - used for marking the test, and filtering
mytestduration: test duration for the execution
<x:Header/>
<x:Body>
<urn:configureN2NListExecution>
<urn:TestType>Network KPI</urn:TestType>
<urn:NodeFrom>AWSprivate2</urn:NodeFrom>
<urn:NodeTo>AWSprivate4,AWSprivate3,AWSprivate5</urn:NodeTo>
<urn:OneToOne>0</urn:OneToOne>
<urn:Frequency>0</urn:Frequency>
<urn:EnforceSchedule>0</urn:EnforceSchedule>
<urn:mystartdate></urn:mystartdate>
<urn:myenddate></urn:myenddate>
<urn:arrayOptionsNameString>null</urn:arrayOptionsNameString>
<urn:arrayOptionsValueString>null</urn:arrayOptionsValueString>
<urn:thresholdArrayString>null</urn:thresholdArrayString>
<urn:AlarmType>0</urn:AlarmType>
<urn:FailedAlarm>0</urn:FailedAlarm>
<urn:ErrorAlarm>0</urn:ErrorAlarm>
<urn:StatusChangeAlarm>0</urn:StatusChangeAlarm>
<urn:EmailAddress></urn:EmailAddress>
<urn:TESTEXEC_STRING>webservice</urn:TESTEXEC_STRING>
<urn:mytestduration>15</urn:mytestduration>
</urn:configureN2NListExecution>
</x:Body>
</x:Envelope>
913-2383-01 Rev A – 78 –
output:
response with 0 in case no test was able to be configured
response with array of executed test paths and Test execution ID if the test could be added to the
execution list
Example of output
(AWSprivate2,AWSprivate4,74),(AWSprivate2,AWSprivate3,75),(AWSprivate2,AWSprivate5,76)

<SOAP-ENV:Body>
<ns1:configureN2NListExecutionResponse>
<return xsi:type="xsd:string">(AWSprivate2,AWSprivate4,74),
(AWSprivate2,AWSprivate3,75),(AWSprivate2,AWSprivate5,76)</return>
</ns1:configureN2NListExecutionResponse>
</SOAP-ENV:Body>
configureTestExecution
Use this function to setup a new test for Node to Node or Real service
Parameters:
Type:
"N2N": defines node to node
"RealService": defines RealService
TestType : test type to trigger the test with
Includes
"Network KPI"
– 79 – 913-2383-01 Rev A
"Adapative Video"
"Flash RTMP"
"Netflix"
"Youtube"
"Skype4B Traffic"
"Video Stream"
"Network KPI 3 COS"
"Voice from->to"
"Exchange_traffic"
"HTTP Test"
"HTTPS Test"
913-2383-01 Rev A – 80 –
"FTP Response Time"
"SIP Response Time"
"DNS Response Time"
"TCP Response Time"
for real services
"BitTorrent"
"DNS Test"
"DropBox Download"
"DropBox Upload"
"Email"
"FTP Download"
"FTP Multistream Download"
"HTTP response time"
"HTTP Server Test"
"HTTP Server Test - Advanced"
"ICMP performance"
"ICMP Test"
"IGMP Test"
"TCP ping"
"Traceroute"
"UDP ping"
"Wi-Fi Connect"
"Wi-Fi Inspect"
"Youtube Test"
isMesh= defines if the mesh option should be used
– 81 – 913-2383-01 Rev A
0 - nodefrom and nodeto will be used for node to node, Meshid ignored
1- meshid will be used, nodefrom and nodeto will be ignored
myMesh - defines meshID for the test (integer)
NodeFrom: node List to use to start the test
Nodeto: node List to use to start the test - ignored for real services
Frequency: frequency in minutes you want to run the test with
0 means one shot
EnforceSchedule: set the enforce scheduling to 0 (not enforce) or 1 (enforce)
mystartdate: schedule start date - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15)
Note: leave empty for starting now or for immediate one shot
myenddate: schedule end date - format is YYYY-MM-DD HH:mm:ss (example 2016-02-01 20:07:15)
Note: leave empty for never ending schedule or one shot
arrayOptionsNameString: define the names of the options for the test
arrayOptionsValueString: define the values of the options for the test
913-2383-01 Rev A – 82 –
following table describe the parameter. for each test type, the options need to be put in the exact order
as detailed in the table below.
IF there is an associated pair (pair_id is not null), the name must be entered with following format in
API:
ParameterName|SPECIFICPAIR|pair_id
If the pair_id is 0 then ParameterName is sufficient
arrayOptionsValueString will contain the exact value
Example for UDP throughput bidirectional test:
arrayOptionsNameString
packetsize,QOS,bitrate|SPECIFICPAIR|15161,bitrate|SPECIFICPAIR|15162
arrayOptionsValueString
1400,EF,20000,40000
will set packetsize to 1400, QOS to EF, UDP from->to 20000kbps, UDP to->from to 40000kbps
"Test Name";"ParameterName";"Display Name";"assodciated pair_id";"Associated pair Name"
"Adapative Video";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Adapative Video";"BitRatesList";"Bitrates List (Mbps)";"6005";"Stream"
"Adapative Video";"QOS";"DSCP Setting";"6005";"Stream"
"Adaptive video with network quality";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Adaptive video with network quality";"QOS";"DSCP Setting";"0";NULL
"Adaptive video with network quality";"BitRatesList";"Bitrates List (Mbps)";"6007";"Stream"
"COS line qualification";"filesize";"File Size (bytes)";"0";NULL
"COS line qualification";"DestinationPort";"Destination Port";"12111";"TCP from->to HIGH"
"COS line qualification";"QOS";"DSCP Setting";"12111";"TCP from->to HIGH"
"COS line qualification";"DestinationPort";"Destination Port";"12112";"TCP from->to MEDIUM"
– 83 – 913-2383-01 Rev A
"COS line qualification";"QOS";"DSCP Setting";"12112";"TCP from->to MEDIUM"
"COS line qualification";"DestinationPort";"Destination Port";"12113";"TCP from->to LOW"
"COS line qualification";"QOS";"DSCP Setting";"12113";"TCP from->to LOW"
"COS line qualification";"bitrate";"Total bitrate (kbps)";"12114";"Voice"
"COS line qualification";"DestinationPort";"Destination Port";"12114";"Voice"
"COS line qualification";"QOS";"DSCP Setting";"12114";"Voice"
"DNS Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"DNS Response Time";"testscript";"Test Script";"0";NULL
"Exchange_traffic";"numberofpairs";"Number of Users";"0";NULL
"Exchange_traffic";"bitrate";"Total bitrate (kbps)";"31014";"Exchange send"
"Exchange_traffic";"filesize";"email size (kbytes)";"31014";"Exchange send"
"Exchange_traffic";"bitrate";"Total bitrate (kbps)";"31015";"Exchange rcv"
"Exchange_traffic";"filesize";"email size (kbytes)";"31015";"Exchange rcv"
"Flash RTMP";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Flash RTMP";"QOS";"DSCP Setting";"0";NULL
"Flash RTMP";"BitRatesList";"Bitrates List (Mbps)";"6006";"Stream"
"FTP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"FTP Response Time";"testscript";"Test Script";"0";NULL
"HTTP Test";"bitrate";"Total bitrate (kbps)";"0";NULL
"HTTP Test";"testscript";"Test Script";"0";NULL
"HTTPS Test";"bitrate";"Total bitrate (kbps)";"0";NULL
"HTTPS Test";"testscript";"Test Script";"0";NULL
"Skype4B Traffic";"numberofpairs";"Number Of Pairs";"0";NULL
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7005";"Audio RTP from->to"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7005";"Audio RTP from->to"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7006";"Audio RTP to->from"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7006";"Audio RTP to->from"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7007";"Video RTP from->to"
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7007";"Video RTP from->to"
"Skype4B Traffic";"bitrate";"Total bitrate (kbps)";"7008";"Video RTP to->from"
913-2383-01 Rev A – 84 –
"Skype4B Traffic";"packetsize";"packet size (bytes)";"7008";"Video RTP to->from"
"Skype4B Traffic from->to";"numberofpairs";"Number Of Pairs";"0";NULL
"Skype4B Traffic from->to";"bitrate";"Total bitrate (kbps)";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"packetsize";"packet size (bytes)";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"QOS";"DSCP Setting";"7009";"Audio RTP from->to"
"Skype4B Traffic from->to";"bitrate";"Total bitrate (kbps)";"7010";"Video RTP from->to"
"Skype4B Traffic from->to";"packetsize";"packet size (bytes)";"7010";"Video RTP from->to"
"Skype4B Traffic from->to";"QOS";"DSCP Setting";"7010";"Video RTP from->to"
"Multicast Video over RTP";"bitrate";"Total bitrate (kbps)";"0";NULL
"Multicast Video over RTP";"QOS";"DSCP Setting";"0";NULL
"Multicast Video over RTP";"MulticastAddressAndPort";"Multicast Address:Port";"6010";"Video from-

>to"
"Netflix";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Netflix";"QOS";"DSCP Setting";"0";NULL
"Netflix";"BitRatesList";"Video Rates";"15202";"Video Stream"
"Netflix";"BitRatesList";"Audio Rates";"15203";"Audio Stream"
"Network KPI";"QOS";"DSCP Setting";"0";NULL
"Network KPI Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
"Network KPI Advanced";"packetsize";"packet size (bytes)";"0";NULL
"Network KPI Advanced";"QOS";"DSCP Setting";"0";NULL
"Network KPI bidirectionnal";"QOS";"DSCP Setting";"0";NULL
"Network KPI to->from";"QOS";"DSCP Setting";"0";NULL
"POP3 Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"POP3 Response Time";"testscript";"Test Script";"0";NULL
"SIP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
"SIP Response Time";"testscript";"Test Script";"0";NULL
"SMTP Response Time";"bitrate";"Total bitrate (kbps)";"0";NULL
– 85 – 913-2383-01 Rev A
"SMTP Response Time";"testscript";"Test Script";"0";NULL
"TCP Response Time";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput Advanced";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Advanced";"filesize";"File Size (bytes)";"0";NULL
"TCP Throughput Advanced";"packetsize";"Send buffer Size";"0";NULL
"TCP Throughput Advanced";"DestinationPort";"Destination Port";"0";NULL
"TCP Throughput Advanced";"SourcePort";"Source Port";"0";NULL
"TCP Throughput Advanced";"sendsocketbuffer_e1";"send socket buffer e1";"0";NULL
"TCP Throughput Advanced";"sendsocketbuffer_e2";"send socketbuffer e2";"0";NULL
"TCP Throughput bidirectional";"bitrate";"Throughput from->to (kbps)";"15157";"TCP from->to"
"TCP Throughput bidirectional";"bitrate";"Throughput to->from (kbps)";"15158";"TCP to->from"
"TCP Throughput from->to 1 stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput from->to 1 stream";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput from->to N streams";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput from->to N streams";"numberofpairs";"Number Of Pairs";"0";NULL
"TCP Throughput from->to N streams";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput Optimized Window size";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput Optimized Window size";"ExpectedLineDelay";"Expected Line One Way Delay

(ms)";"0";NULL
"TCP Throughput Optimized Window size";"filesize";"File Size (bytes)";"0";NULL
"TCP Throughput Optimized Window size";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput to->from 1 stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput to->from 1 stream";"QOS";"DSCP Setting";"0";NULL
"TCP Throughput to->from N streams";"bitrate";"Total bitrate (kbps)";"0";NULL
"TCP Throughput to->from N streams";"numberofpairs";"Number Of Pairs";"0";NULL
"TCP Throughput to->from N streams";"QOS";"DSCP Setting";"0";NULL
"Traffic Mix - HTTP - Video - Voice";"bitrate";"Total bitrate (kbps)";"40013";"Video from->to"
"Traffic Mix - HTTP - Video - Voice";"bitrate";"Total bitrate (kbps)";"40014";"HTTP from->to"
913-2383-01 Rev A – 86 –
"UDP Throughput Advanced";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput Advanced";"QOS";"DSCP Setting";"0";NULL
"UDP Throughput Advanced";"filesize";"File Size (bytes)";"0";NULL
"UDP Throughput Advanced";"packetsize";"Send buffer Size";"0";NULL
"UDP Throughput Advanced";"DestinationPort";"Destination Port";"0";NULL
"UDP Throughput Advanced";"SourcePort";"Source Port";"0";NULL
"UDP Throughput from->to";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput from->to";"packetsize";"Packet Size";"0";NULL
"UDP Throughput from->to";"QOS";"DSCP Setting";"0";NULL
"UDP Throughput to->from";"bitrate";"Total bitrate (kbps)";"0";NULL
"UDP Throughput to->from";"packetsize";"Packet Size";"0";NULL
"UDP Throughput to->from";"QOS";"DSCP Setting";"0";NULL
"Video Stream";"bitrate";"Total bitrate (kbps)";"0";NULL
"Video Stream";"QOS";"DSCP Setting";"0";NULL
– 87 – 913-2383-01 Rev A
"Voice bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice bidirectional";"QOS";"DSCP Setting";"0";NULL
"Voice from->to";"voicecodec";"Voice Codec";"0";NULL
"Voice from->to";"QOS";"DSCP Setting";"0";NULL
"Voice N pairs - UDP Data bidirectional";"bitrate";"Total bitrate (kbps)";"0";NULL
"Voice N pairs - UDP Data bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N pairs - UDP Data bidirectional";"packetsize";"Packet Size";"0";NULL
"Voice N pairs - UDP Data bidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs bidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N Pairs bidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs bidirectional";"QOS";"DSCP Setting";"0";NULL
"Voice N Pairs Unidirectional";"voicecodec";"Voice Codec";"0";NULL
"Voice N Pairs Unidirectional";"numberofpairs";"Number Of Pairs";"0";NULL
"Voice N Pairs Unidirectional";"QOS";"DSCP Setting";"0";NULL
"Youtube";"numberofpairs";"Number Of parallel Streams";"0";NULL
"Youtube";"QOS";"DSCP Setting";"0";NULL
"Youtube";"BitRatesList";"Video Rates";"15204";"Video Stream"
For real services the parameters include:
"BitTorrent";"DestinationServer";"Torrent Name";"0";NULL
"BitTorrent";"magnet";"Torrent link";"0";NULL
"BitTorrent";"duration";"Test duration";"0";NULL
"DNS Test";"DestinationServer";"DNS Server IP address (default uses configured)";"0";NULL
"DNS Test";"NameToResolve";"Name to resolve";"0";NULL
"DropBox Download";"DestinationServer";"DropBox File";"0";NULL
"DropBox Download";"Timeout";"Timeout (sec)";"0";NULL
"DropBox Upload";"DestinationServer";"DropBox File";"0";NULL
"DropBox Upload";"Timeout";"Timeout (sec)";"0";NULL
"Email";"email";"Email Address";"0";NULL
"Email";"smtp";"Outgoing mail server (SMTP)";"0";NULL
913-2383-01 Rev A – 88 –
"Email";"smtpport";"Outgoing mail port";"0";NULL
"Email";"smtpAUTHprotocol";"SMTP authentication protocol";"0";NULL
"Email";"smtpuser";"SMTPAUTH User (if needed)";"0";NULL
"Email";"smtppass";"SMTPAUTH Password (if needed)";"0";NULL
"Email";"imap";"Incoming mail server";"0";NULL
"Email";"imapport";"Incoming mail port";"0";NULL
"Email";"mailproto";"Incoming mail protocol";"0";NULL
"Email";"authuser";"Mail User";"0";NULL
"Email";"authpass";"Mail Password";"0";NULL
"FTP Download";"DestinationServer";"Destination Server";"0";NULL
"FTP Download";"DownloadFile";"Downlad File";"0";NULL
"FTP Download";"FTP_auth";"Use Authentication";"0";NULL
"FTP Download";"UserName";"User name";"0";NULL
"FTP Download";"UsePassiveMode";"Use Passive Mode";"0";NULL
"FTP Download";"Password";"Password";"0";NULL
"FTP Download";"Timeout";"Timeout (sec)";"0";NULL
"FTP Multistream Download";"DestinationServer";"Destination Server";"0";NULL
"FTP Multistream Download";"Timeout";"Timeout (sec)";"0";NULL
"FTP Multistream Download";"DownloadFile";"Downlad File";"0";NULL
"FTP Multistream Download";"FTP_auth";"Use Authentication";"0";NULL
"FTP Multistream Download";"UserName";"User name";"0";NULL
"FTP Multistream Download";"numberofstreams";"Number Of Streams";"0";NULL
"FTP Multistream Download";"Password";"Password";"0";NULL
"HTTP response time";"DestinationServer";"Destination Page (webserver/page)";"0";NULL
"HTTP response time";"Protocol";"Protocol";"0";NULL
"HTTP response time";"NumberofTests";"Number of Tests";"0";NULL
"HTTP response time";"RealServiceCOS";"Class of Service";"0";NULL
"HTTP response time";"UseProxy";"Use Proxy Server";"0";NULL
"HTTP response time";"ip_version";"ip protocol";"0";NULL
"HTTP response time";"ProxyAddress";"Proxy Address";"0";NULL
– 89 – 913-2383-01 Rev A
"HTTP Server Test";"DestinationServer";"Destination Servers";"0";NULL
"HTTP Server Test";"DownloadFullPage";"Download Full Page";"0";NULL
"HTTP Server Test";"ip_version";"ip protocol";"0";NULL
"HTTP Server Test";"UseProxy";"Use Proxy Server";"0";NULL
"HTTP Server Test";"ProxyAddress";"Proxy Address";"0";NULL
"HTTP Server Test";"UserAgentString";"User Agent String";"0";NULL
"HTTP Server Test - Advanced";"DestinationServer";"Destination Servers";"0";NULL
"HTTP Server Test - Advanced";"DownloadFullPage";"Download Full Page";"0";NULL
"HTTP Server Test - Advanced";"DNSServer";"DNS Server";"0";NULL
"HTTP Server Test - Advanced";"ip_version";"ip protocol";"0";NULL
"HTTP Server Test - Advanced";"UseProxy";"Use Proxy Server";"0";NULL
"HTTP Server Test - Advanced";"ProxyAddress";"Proxy Address";"0";NULL
"HTTP Server Test - Advanced";"UserAgentString";"User Agent String";"0";NULL
"ICMP performance";"DestinationServer";"Destination Server";"0";NULL
"ICMP performance";"throughput";"Throughput (kbps)";"0";NULL
"ICMP performance";"ICMP_PacketSize";"Packet Size";"0";NULL
"ICMP performance";"TestDurationSeconds";"Test Duration (Seconds)";"0";NULL
"ICMP performance";"RealServiceCOS";"Class of Service";"0";NULL
"ICMP Test";"DestinationServer";"Destination Servers";"0";NULL
"ICMP Test";"PingInterval";"Interval";"0";NULL
"ICMP Test";"PingCount";"Count";"0";NULL
"ICMP Test";"PingPacketSize";"Packet Size";"0";NULL
"ICMP Test";"ip_version";"ip protocol";"0";NULL
"ICMP Test";"RealServiceCOS_icmp";"Class of Service";"0";NULL
"ICMP Test";"EnableJitter";"Jitter Calculation";"0";NULL
"IGMP Test";"Duration";"duration (sec)";"0";NULL
"IGMP Test";"igmp_interface";"probe interface";"0";NULL
"IGMP Test";"multicast_address";"multicast address";"0";NULL
"IGMP Test";"source_address";"source address";"0";NULL
"IGMP Test";"packets";"stream analytics";"0";NULL
913-2383-01 Rev A – 90 –
"TCP ping";"DestinationServer";"Destination Servers";"0";NULL
"TCP ping";"PingInterval";"Interval";"0";NULL
"TCP ping";"PingCount";"Count";"0";NULL
"TCP ping";"PingPacketSize";"Packet Size";"0";NULL
"TCP ping";"TCPport";"Remote port";"0";NULL
"TCP ping";"RealServiceCOS";"Class of Service";"0";NULL
"Traceroute";"DestinationServer";"Destination Server";"0";NULL
"Traceroute";"Timeout";"Timeout (sec)";"0";NULL
"Traceroute";"QOS";"DSCP Setting";"0";NULL
"Traceroute";"TraceRouteProtocol";"Protocol";"0";NULL
"Traceroute";"ip_version";"ip protocol";"0";NULL
"UDP ping";"DestinationServer";"Destination Servers";"0";NULL
"UDP ping";"PingInterval";"Interval";"0";NULL
"UDP ping";"PingCount";"Count";"0";NULL
"UDP ping";"PingPacketSize";"Packet Size";"0";NULL
"UDP ping";"TCPport";"Remote port";"0";NULL
"UDP ping";"RealServiceCOS";"Class of Service";"0";NULL
"Wi-Fi Connect";"AuthenticationMethod";"Authentication Method";"0";NULL
"Wi-Fi Connect";"SSID";"SSID";"0";NULL
"Wi-Fi Connect";"BSSID";"BSSID";"0";NULL
"Wi-Fi Connect";"Passphrase";"Passphrase (WPA-PSK)";"0";NULL
"Wi-Fi Connect";"UserName";"User name";"0";NULL
"Wi-Fi Connect";"Password";"Password";"0";NULL
"Wi-Fi Connect";"ResetInterface";"Reset interface after test";"0";NULL
"Wi-Fi Connect";"specialWi-Fiscript";"Captive Portal script (optional)";"0";NULL
"Wi-Fi Connect";"ConnectivityURL";"Ping Address";"0";NULL
"Wi-Fi Connect";"CustomWPA";"Custom wpa content";"0";NULL
"Wi-Fi Inspect";"DestinationServer";"SSID";"0";NULL
"Youtube Test";"DestinationServer";"Video code or url";"0";NULL
"Youtube Test";"Timeout";"Timeout (sec)";"0";NULL
– 91 – 913-2383-01 Rev A
"Youtube Test";"NameForVideo";"Video Name (optional)";"0";NULL
"Youtube Test";"VideoFormat";"Video Format";"0";NULL
thresholdArrayString sets specific threshold parameters - leave empty to use default threashold
settings
AlarmType:0 -no alarm
1-email
2-snmp
3- email And snmp
FailedAlarm-
0 - do not raise alarm on fail
1 - do raise alarm on fail
ErrorAlarm-
0 - do not raise alarm on error
1 - do raise alarm on error
StatusChangeAlarm-
0 - do not raise alarm on statuschange
1 - do raise alarm on statuschange
EmailAddress - string - email address so to send email alarm to
TESTEXEC_STRING: string - used for marking the test, and filtering
mytestduration: test duration for the execution
913-2383-01 Rev A – 92 –
<x:Header/>
<x:Body>
<urn:configureTestExecution>
<urn:Type>?</urn:Type>
<urn:TestType>?</urn:TestType>
<urn:isMesh>?</urn:isMesh>
<urn:myMesh>?</urn:myMesh>
<urn:NodeFrom>?</urn:NodeFrom>
<urn:NodeTo>?</urn:NodeTo>
<urn:Frequency>?</urn:Frequency>
<urn:EnforceSchedule>?</urn:EnforceSchedule>
<urn:mystartdate>?</urn:mystartdate>
<urn:myenddate>?</urn:myenddate>
<urn:arrayOptionsNameString>?</urn:arrayOptionsNameString>
<urn:arrayOptionsValueString>?</urn:arrayOptionsValueString>
<urn:thresholdArrayString>?</urn:thresholdArrayString>
<urn:AlarmType>?</urn:AlarmType>
<urn:FailedAlarm>?</urn:FailedAlarm>
<urn:ErrorAlarm>?</urn:ErrorAlarm>
<urn:StatusChangeAlarm>?</urn:StatusChangeAlarm>
<urn:EmailAddress>?</urn:EmailAddress>
<urn:TESTEXEC_STRING>?</urn:TESTEXEC_STRING>
<urn:mytestduration>?</urn:mytestduration>
</urn:configureTestExecution>
</x:Body>
</x:Envelope>
output:
response with 0 in case no test was able to be configured
response with testExec ID if the test could be added in queue.

<SOAP-ENV:Body>
<ns1:configureTestExecutionResponse>
</ns1:configureTestExecutionResponse>
</SOAP-ENV:Body>
findProbeIDfromName
– 93 – 913-2383-01 Rev A
Find probe ID from inputting name
Input: ProbeName as string with name of the probe to look at
<x:Header/>
<x:Body>
<urn:findProbeIDfromName>
<urn:ProbeName>?</urn:ProbeName>
</urn:findProbeIDfromName>
</x:Body>
</x:Envelope>
output
API will return 0 if probe is not found, integer with ID if the probe is found.

<SOAP-ENV:Body>
<ns1:findProbeIDfromNameResponse>
</ns1:findProbeIDfromNameResponse>
</SOAP-ENV:Body>
findProbeIDfromSerialRequest
Find probe ID from input serial number
Input:
Serial as string with serial number of the probe to look at
<x:Header/>
<x:Body>
<urn:findProbeIDfromSerial>
<urn:Serial>?</urn:Serial>
</urn:findProbeIDfromSerial>
</x:Body>
913-2383-01 Rev A – 94 –
</x:Envelope>
findProbeIDfromSerialResponse
Output:
API will return 0 if probe is not found, integer with ID if the probe is found.

<SOAP-ENV:Body>
<ns1:findProbeIDfromSerialResponse>
</ns1:findProbeIDfromSerialResponse>
</SOAP-ENV:Body>
listProbesNamesRequest
List all probes matching specified filters
Input:
ProbeName: probe name filter
Status: probe status filter
available values
0 - all probes
1 - all up probes
2 - all down probes
<x:Header/>
<x:Body>
<urn:listProbesNames>
<urn:ProbeName>?</urn:ProbeName>
<urn:Status>?</urn:Status>
</urn:listProbesNames>
</x:Body>
</x:Envelope>
listProbesNamesResponse
Output:
API will return 0 if no matching probe is found, a comma-separated string with all
– 95 – 913-2383-01 Rev A
matching probe names.

<SOAP-ENV:Body>
<ns1:listProbesNamesResponse>
<return xsi:type="xsd:string">Probe1,Probe2</return>
</ns1:listProbesNamesResponse>
</SOAP-ENV:Body>
testWebService
This is a test method to validate connectivity to Hawkeye SOAP server.
Input:
Param1: string
Param2: string
<x:Header/>
<x:Body>
<urn:testWebService>
<urn:Param1>p1</urn:Param1>
<urn:Param2>p2</urn:Param2>
</urn:testWebService>
</x:Body>
testWebServiceResponse
Output:
string - "Test IXIA HawkeyeWebServices <Param1> <Param2>"

<SOAP-ENV:Body>
<ns1:testWebServiceResponse>
<return xsi:type="xsd:string">Test IXIA HawkeyeWebServices p1 p2</return>
</ns1:testWebServiceResponse>
913-2383-01 Rev A – 96 –
</SOAP-ENV:Body>
– 97 – 913-2383-01 Rev A
This page intentionally left blank.
913-2383-01 Rev A – 98 –
© Keysight Technologies, 2019
Ixia, a Keysight Business

26601 West Agoura Road
Calabasas, California 91302

Hawkeye Advance Admin Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Hawkeye Advance Admin Guide

Hochgeladen von

Copyright:

Verfügbare Formate

Hawkeye

Global Support +1 818 595 2599 support@ixiacom.com

Regional and local support contacts:

APAC Support +91 80 4939 6410 support@ixiacom.com

Australia +61-742434942 support@ixiacom.com

EMEA Support +40 21 301 5699 support-emea@ixiacom.com

Greater China Region +400 898 0598 support-china@ixiacom.com

Hong Kong +852-30084465 support@ixiacom.com

India Office +91 80 4939 6410 support-india@ixiacom.com

Japan Head Office +81 3 5326 1980 support-japan@ixiacom.com

Korea Office +82 2 3461 0095 support-korea@ixiacom.com

Singapore Office +65-6215-7700 support@ixiacom.com

Taiwan (local toll-free number) 00801856991 support@ixiacom.com

– iii – 913-2383-01 Rev A

Describing interactions with the UI

Input-neutral Mouse Touch

Select Modify. Click Modify. Tap Modify.

Select Protocols. Click the Protocols tab. Tap Protocols.

-NA- Double-click the Client wizard. Double-tap the Client wizard.

Old usage... New usage...

shortcut menu, right-click menu context menu

click, right-click select

drag and drop drag

About this guide 1

Note icons and messages 1

Chapter 1 Advanced Administration Guide 3

OSS (Operations Support System) Integration 5

MySQL Database Management 6

Hawkeye Database : Enabling Remote Access 11

Hawkeye Database Test Results Structure 15

Test Result Storage Structure 15

Fast backup or restore of Hawkeye MySQL database 17

Probe Management - Probe Busy 18

Captive Portal Support for Wi-Fi 20

Hawkeye Folder Structure 26

Speed Test using Global Servers 26

Set up e-mails with Hawkeye server 26

Hawkeye Ports for Manual Endpoints 29

Manage Manual Endpoints behind NAT 31

–v– 913-2383-01 Rev A

Hawkeye SNMP MIB Information 36

Associated MIB Descriptors 43

SOAP Web Services API 44

Note icons and messages

Name Icon Description

Note Indicates information that emphasizes or supplements important points in the

Important Indicates information that is essential to the completion of a task.

Tip Provides supplemental suggestions for applying techniques and procedures to

bold text Bold text indicates:

–1– 913-2383-01 Rev A

Italic text Italic text indicates:

monospace Text shown in a monospace font is used to indicate:

> (right angle Separates levels in a hierarchy of menu selections.

913-2383-01 Rev A –2–

MySQL Database Management 6

Hawkeye Database : Enabling Remote Access 11

Hawkeye Database Test Results Structure 15

Test Result Storage Structure 15

Fast backup or restore of Hawkeye MySQL database 17

Probe Management - Probe Busy 18

Captive Portal Support for Wi-Fi 20

Hawkeye Folder Structure 26

Speed Test using Global Servers 26

Set up e-mails with Hawkeye server 26

# -- coding: utf-8 --