Hawkeye

Integration Guide

Version 2.0
September 2016
Copyright and Disclaimer

Copyright © 2016 Ixia. All rights reserved.

This publication may not be copied, in whole or in part, without Ixia's consent.

Ixia, the Ixia logo, and all Ixia brand names and product names in this document are
either trademarks or registered trademarks of Ixia in the United States and/or other
countries. All other trademarks belong to their respective owners.

The information herein is furnished for informational use only, is subject to change by
Ixia without notice, and should not be construed as a commitment by Ixia. Ixia assumes
no responsibility or liability for any errors or inaccuracies contained in this publication.

RESTRICTED RIGHTS NOTICE

As prescribed by FAR 27.409(b)(4) and in accordance with FAR 52.227-14, please take
notice of the following.

(a) This proprietary computer software and/or software technical data is submitted
with restricted rights. It may not be used, reproduced, or disclosed by the Govern-
ment except as provided in paragraph (b) of this notice or as otherwise expressly
stated in the applicable contract.

(b) This computer software and/or software technical data may be—

(1) Used or copied for use with the computer(s) for which it was acquired, includ-
ing use at any Government installation to which the computer(s) may be trans-
ferred;

(2) Used or copied for use with a backup computer if any computer for which it was
acquired is inoperative;

(3) Reproduced for safekeeping (archives) or backup purposes;

(4) Modified, adapted, or combined with other computer software, provided that
the modified, adapted, or combined portions of the derivative software incor-
porating any of the delivered, restricted computer software shall be subject to the
same restricted rights;

(5) Disclosed to and reproduced for use by support service Contractors or their sub-
contractors in accordance with paragraphs (b)(1) through (4) of this notice; and

(6) Used or copied for use with a replacement computer.

ii Hawkeye Integration Guide

 (c) Notwithstanding the foregoing, if this computer software and/or software technical
data is copyrighted computer software and/or software technical data, it is licensed
to the Government with the minimum rights set forth in paragraph (b) of this notice.

(d) Any other rights or limitations regarding the use, duplication, or disclosure of this
computer software and/or software technical data are to be expressly stated in, or
incorporated in, the applicable contract.

(e) This notice shall be marked on any reproduction of this computer software, in
whole or in part.

(End of notice)

iii Hawkeye Integration Guide

 Contacting Ixia

Contacting Ixia
Corporate Ixia Worldwide Headquarters Web site: [Link]
Headquarters 26601 W. Agoura Rd. General: info@[Link]
Calabasas, CA 91302
USA Investor Relations: ir@[Link]
+1 877 FOR IXIA (877 367 4942) Training: training@[Link]
+1 818 871 1800 (International) Support: support@[Link]
(FAX) +1 818 871 1805 +1 818 595 2599
sales@[Link]

EMEA Ixia Europe Limited Support: support-emea@ixi-

Part 2nd floor, [Link]
Clarion House, Norreys Drive +40 21 301 5699
Maidenhead, UK SL6 4FL
+44 (1628) 408750
FAX +44 (1628) 639916
salesemea@[Link]

Asia Pacific Ixia Pte Ltd Support: support-asiapac@ixi-

210 Middle Road [Link]
#08-01 IOI Plaza +91 80 4939 6410
Singapore 188994

Japan Ixia KK Support: support-japan@ixi-

Nishi-Shinjuku Mitsui Bldg 11F [Link]
6-24-1, Nishi-Shinjuku, Shinjuku-ku +81 3 5326 1980
Tokyo 160-0023
Japan

India Ixia Technologies Pvt Ltd Support: support-indi-

Tower 1, 7th Floor, UMIYA Business Bay a@[Link]
Cessna Business Park +91 80 4939 6410
Survey No. 10/1A, 10/2, 11 & 13/2
Outer Ring Road, Varthur Hobli
Kadubeesanahalli Village
Bangalore East Taluk
Bangalore-560 037, Karnataka, India
+91 80 42862600

China Ixia Technologies (Shanghai) Company Ltd Support: support-chin-

a@[Link]
Unit 3, 11th Floor, Raffles City, Beijing 400 898 0598 (Greater China
Beijing, 100007 P.R.C. Region)
+86 10 5732 3932 (Hong Kong)

Hawkeye Integration Guide iv

Contacting Ixia

v Hawkeye Integration Guide

 Contacting Ixia iv
CONTENTS

CONTENTS vi

Hawkeye OSS (Operations Support System) integ-

ration viii

Hawkeye SNMP alarms viii

Hawkeye Email notifications viii

Hawkeye MySQL database ix

Hawkeye SOAP web services API ix

MySQL database Management xi

Hawkeye database xi

MySQL web admin xiii

Hawkeye database : changing root password xv

Hawkeye database : enabling remote access xvii

Hawkeye database : run sql script xx

Hawkeye database test results structure xxii

Test result storage structure xxii

Hawkeye Integration Guide vi

CONTENTS

MySQL test data structures xxv

MySQL advanced configuration for performance xxvi

MySQL advanced configuration for performance xxvii

Manage configuration file xxx

Section MySQL Database xxxiii

Section “Main” xxxiv

Section “Log Management” xxxvii

Section Process Cleanup xxxviii

Section Test Agent xxxviii

Apache Server xli

Hawkeye Services xliv

SOAP web services API xlvi

Activating SOAP in Hawkeye xlvii

Activating SOAP wsdl file xlvii

SOAP API guide xlviii

Manage users from Active Directory cvii

Index 110

vii Hawkeye Integration Guide

 Hawkeye OSS (Operations Support System) integration

Hawkeye OSS (Operations Support System)

integration
Hawkeye is designed to be an open framework for easy integration into service pro-
viders 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 Integration Guide viii

Hawkeye OSS (Operations Support System) integration

Hawkeye MySQL database

Hawkeye database has been designed to be efficiently integrated to third party report-
ing 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 inform-
ation 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.

Hawkeye 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.

The generic API guide provided is a first version, but global framework for building more
APIs is ready and through custom deliveries and enhancements, Ixia Professional Ser-
vices team can provide some extra functions or dedicated functions through APIs.

ix Hawkeye Integration Guide

 Hawkeye OSS (Operations Support System) integration

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 exten-
sion. It is therefore compatible with any SOAP client and agnostic about the connecting
technology.

It is installed over the same web server than GUI and is listening on incoming request
on port 80.

It publishes WSDL file format for creating SOAP client connector and publishing all avail-
able APIs.

Hawkeye Integration Guide x

MySQL database Management

MySQL database Management

Hawkeye database

Hawkeyeapplication uses mysql database 5.1.73

The configuration file for the MySQL server is /etc/[Link]. 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 moun-
ted 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

xi Hawkeye Integration Guide

 MySQL database Management

#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/[Link]

user=mysql

# Disabling symbolic-links is recommended to prevent assorted security

risks

symbolic-links=0

[mysqld_safe]

log-error=/var/log/[Link]

pid-file=/var/run/mysqld/[Link]

slow-query-log = 1

slow-query-log-file = /home/mysql_data/[Link]

Hawkeye Integration Guide xii

MySQL database Management

the mysql runs as a service:

start: service mysqld start

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:
[Link]

To access to the Hawkeye Web Portal database administration tool use the following
URL:

[Link]

xiii Hawkeye Integration Guide

 MySQL database Management

The default credentials to login are:

Username: root

Password: Ixia123

If selected, the complete database will appear and be available, with table size in
entries and disk space.

Note: any modifications to the database structure and con-

tent directly made into the database can severely affect
operations. This shouldnt be done by non certified engin-
eers and under Ixia Support supervision.

Hawkeye Integration Guide xiv

MySQL database Management

Hawkeye database : changing root password

For full advanced procedure refer to:

[Link]

Using phpmyadmin interface:

Login as root,

go to users tab

click edit privileges for root user

xv Hawkeye Integration Guide

 MySQL database Management

scroll down

fill in 2 new passwords and selec GO

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/[Link]

Hawkeye Integration Guide xvi

MySQL database Management

----------------------------------------

## Hawkeye configuration file

[MySQLDatabase]

"MySQL_Host" == "localhost"

"MySQL_Database" == "HawkeyePro"

"MySQL_User" == "root"

"MySQL_Password" == "Password0"

"MySQL_UseSSL" == "0"

change mysql password to new password as reconfigured

Hawkeye database : enabling remote access

Using phpmyadmin interface:

Login as root,

go to users tab

xvii Hawkeye Integration Guide

 MySQL database Management

click edit privileges for ixia and/or root user (ixia user has restricted priviledges).

scroll down

Hawkeye Integration Guide xviii

MySQL database Management

change host from local to "any host" or "Use text field" where a specific originating IP
can be specified.

It is recommended 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 com-
pletely 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 conncect to it

xix Hawkeye Integration Guide

 MySQL database Management

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.

Recommendation is to run them through phpmyadmin (command line using mysql tool is
also possible, refer to corresponding mysql user guide for this).

steps:

login to phpmyadmin (preferably as root user).

select Hawkeye database database:

Hawkeye Integration Guide xx

MySQL database Management

select SQL tab

paste the required query into the text area:

xxi Hawkeye Integration Guide

 MySQL database Management

run the query hitting the Go button

Hawkeye database test results structure

Hawkeye solution has an underlying database scheme that is used for:

-System information and administration management;

-Test execution Queue Management;

-Test Results storage;

Test result storage structure

Test data record concept

Hawkeye Integration Guide xxii

MySQL database Management

Hawkeye database has been designed to be efficiently integrated to third party report-
ing 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;

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_fil-
ters . A join query on the 2 tables will allow to get explicit information about the con-
tent.

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 inform-

ation 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 typ-
ically used to provide further description of a test result.

xxiii Hawkeye Integration Guide

 MySQL database Management

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, per-
centage, 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 is the total test duration of the TDR
l A value;

Hawkeye Integration Guide xxiv

MySQL database Management

MySQL test data structures

The following drawing illustrates the different tables mentioned above and their struc-
ture.

Standard SQL queries shall be made to get these into any reporting, data mining or data
post processing engines.

xxv Hawkeye Integration Guide

 MySQL database Management

MySQL advanced configuration for performance

see Optimizing MySQL.

Hawkeye Integration Guide xxvi

MySQL advanced configuration for performance

MySQL advanced configuration for performance

After installation it might be necessary to adjust the MySQL parameters to your local
server performance to optimize performance

the mysql optimization parameters are located into /etc/[Link]

The most important parameter that needs to be adjusted is

innodb_buffer_pool_size= 70% of available RAM in server - for example

for 8G RAM, put 5000M (or 5G)

variables that might require adaptation:

port=3306 - changes default port used

Most important for performance:

max_connections is max number of concurrent connexions opened against mysql. This

would only need to increased in case of erratic behaviors on very large configurations.

xxvii Hawkeye Integration Guide

 MySQL advanced configuration for performance

[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-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/[Link]

user=mysql

# Disabling symbolic-links is recommended to prevent assorted security risks symbolic-

links=0

[mysqld_safe]

Hawkeye Integration Guide xxviii

MySQL advanced configuration for performance

log-error=/var/log/[Link] pid-file=/var/run/mysqld/[Link]

slow-query-log = 1

slow-query-log-file = /home/mysql_data/[Link]

xxix Hawkeye Integration Guide

 Manage configuration file

Manage configuration file

Some advanced settings for Hawkeye application is configured through a specific con-
figuration file.

Most of the settings configured are advanced settings. Recommendations from Ixia
before changing them is recommended.

/home/ixia/Hawkeye/conf/[Link]

Default configuration file:

## Hawkeye configuration file; created: Wed Feb 3 16:44:59 EST 2016

## Each section contains information about configurations options

## Check user guide for full information

[MySQLDatabase]

"MySQL_Host" == "localhost"

"MySQL_Database" == "Hawkeye"

"MySQL_User" == "Ixia"

"MySQL_Password" == "Ixia123"

"MySQL_UseSSL" == "0"

"Myresults_SQL_Host" == "localhost"

"Myresults_Database" == "Hawkeye_Result"

"Myresults_SQL_User" == "Ixia"

"Myresults_SQL_Password" == "Ixia123"

"Myresults_SQL_UseSSL" == "0"

[Main]

Hawkeye Integration Guide xxx

Manage configuration file

"IsWebServer" == "1"

"IsTestAgent" == "1"

"WebServerPort" == "80"

"SystemWithDST" == "0"

"maxTimerAgentDaemonSeconds"=="7200"

"maxTimerTestDaemonSeconds"=="60"

"SuperProbeUseRemoteDBCall"=="0"

"RemoteDBCallServer"=="[Link]"

"AllowChassisPortRealTest"=="0"

"PhantomJSPort"=="3013"

"useTimestampTDRID"=="0"

"useExtraFilters"=="0"

"UseOldLicensingScheme"=="0"

"DefaultTimezone"=="America/New_York"

[Installation_Paths]

"server_path"=="/home/ixia/Hawkeye/WebServer/"

"report_path"=="tmp/reports/"

"tmp_img"=="tmp/img"

"saved_report_path"=="SavedReports/"

"chariot_log"=="/home/ixia/Hawkeye/logs/Chariot/"

"server_log"=="/home/ixia/Hawkeye/logs/Hawkeye/"

"ReportHeader"=="images/[Link]"

"download_dir"=="download/"

"tools_dir"=="/home/ixia/Hawkeye/tools/"

[LogManagement]

xxxi Hawkeye Integration Guide

 Manage configuration file

"LogDeleteFrequencyMinutes" == "60"

"DbDeleteFrequencyMinutes"=="60"

[ProcessCleanUp]

"ActivateProcessCleanUp" == "1"

"maxDurationTclProcess_seconds" == "1200"

"maxDurationPHPProcess_seconds" == "3600"

[TestAgent]

"TestAgentName" == "TestAgent1"

"TestAgentRealServiceName" == "RealTestAgent1"

"ProbeDefaultLogin" == "root"

"ProbeDefaultPassword" == "Ixia!123"

"UseIxChariotMultiThreading" == "1"

"DualGateway" == "0"

"DisableProbeCapacityCheck" == "0"

"ProbeHealthCheckPort" == "10115"

"prioritizeLeftToCompleteMesh" == "0"

## This section overrides web references relative to the

## base installation (refs starting with / are absolute)

[WebNamespace]

"web_namespace" == "_"

"web_img" == "images"

"web_tmp_img" == "tmp/img"

"web_report_path" == "tmp/reports"

"web_ReportHeader" == "images/[Link]"

"web_download_dir == "download/"

---------

Hawkeye Integration Guide xxxii

Manage configuration file

Section MySQL Database

In this section of the configuration file, the settings for database connection are con-
figured.

MySQL Database

Feature/Setting Value Comments

MySQL_Host localhost IP or name of the database host

MySQL_Database Hawkeye Name of the database to be used by

Hawkeye . Default Hawkeye.

MySQL_User Ixia Username required to connect to the

database. Default Ixia

MySQL_Password Ixia123 Password required to connect to the

database. Default Ixia123

MySQL_UseSSL 1 or 0 enable/disable the SSL protocol for

MySQL connection

Myresults_SQL_Host localhost Not used

Myresults_MySQL_Data- Hawkeye_ Not used

base result

Myresults_MySQL_User root Not used

Myresults_MySQL_Pass- Password0 Not used

word

Myresults_MySQL_UseSSL 1 or 0 Not used

xxxiii Hawkeye Integration Guide

 Manage configuration file

WARNING: DO NOT modify default the database connection

parameters, unless the database server is located on a dif-
ferent server than the installed server.

Section “Main”

The parameters located in section “Main” of the configuration file are explained, below.

Main

Feature/Setting Default Comments

Value

IsWebServer 1 0 if the localhost is not

Hawkeyeweb server
1 if the localhost is an Hawkeyeweb
server

IsTestAgent 1 0 if the localhost is not Hawkeye

test agent (controller)
1 if the localhost is an Hawkeye
test agent (controller)

WebServerPort 80 Default HTTP port 80. If the port is

different configure it here. E.g. for
HTTPS, configure port 443 – mis-
configuration will result into prob-
lems with creating reports

Hawkeye Integration Guide xxxiv

Manage configuration file

SystemWithDST (deprecated) 0 0 if the system has the day light

time disabled
1 if the system has the day light
time enabled
NOTE: this parameter is not taken
into account since 6.4.0 version

maxTimerAgentDaemonSeconds 7200 Maximum timer (seconds) for the

controller to consider the remote
probes active if no activity is hap-
pening. After this timer the probes
will be considered as unreachable.

maxTimerTestDaemonSeconds 600 Maximum time (seconds) after

which an inactive test agent (con-
troller) is considered as not run-
ning.

SuperProbeUseRemoteDBCall 0 1 identifies that the test controller

(if used as test controller) will call
remote call server based on  web
services instead of sql server. This
is advanced settings and should
always be left to 0 unless recom-
mended by Ixia support.

RemoteDBCallServer 0 Remote DB server to use with web

services. Only active in case of
SuperProbeUseRemoteDBCall is set
to 1.

SuperProbeUseRemoteDBCall 0 Deprecated. Always use 0 for this

parameter.

xxxv Hawkeye Integration Guide

 Manage configuration file

AllowChassisPortRealTest 0 Will enable the ability to use a

chassis port within real services.
Only available on special con-
figuration and should be left to 0
unless recommended by Ixia sup-
port.

PhantomJSPort 3013 Default phantomjs server port.

Phantomjs is used to create images
(png) for graph exports. This port is
used to optimize the process and
run the application as a server.

aggregationlevels 3600,86400 Aggregation levels (in period, unit

is second) used by the data aggreg-
ation collectors. This feature is not
yet fully supported for 6.80

useTimestampTDRID 0 this feature allows when set to 1 to

use different TDR ID format. This
needs to be implemented following
the rules described into Set long
[Link]

useExtraFilters 0 This feature allows the use for extra

filters for probes when set to 1. This
feature needs enablement by Ixia
support with specific configuration
into the database.

Hawkeye Integration Guide xxxvi

Manage configuration file

UseOldLicensingScheme 0 This feature enables to keep using

(deprecated) the old licensing scheme inherited
from 6.70. It is NOT recommended
to set this to 1 unless the new
licensing is not working. The sup-
port of old licensing scheme MAY
be deprecated in coming releases
so if this needs to be enabled Ixia
support must be notified so that the
correct license is generated for full
support of 6.80 without this feature
enabled.

DefaultTimezone Automatic Defines default time zone for the

server

Section “Log Management”

The parameters located in section “Log management” of the configuration file are
explained, below.

Log Management

Feature/Setting Value Comments

LogDeleteFrequencyMinutes 60 How often logs are deleted. This value

is not too high so that frequent file sys-
tem deletion are avoided.

DbDeleteFrequencyMinutes 60 deprecated
(deprecated)

xxxvii Hawkeye Integration Guide

 Manage configuration file

Section Process Cleanup

this section is deprecated - not used anymore.

Section Test Agent

In the section “Test Agent”, the configuration for the Hawkeye test agent parameters
must be done. Below is the explanation of each one of them:

Test agent is often called Test controler

Test Agent

Feature/Setting Default Value Comments

TestAgentName TestAgent1 Name of the test agent. Default

TestAgent1

TestAgentRealServiceName RealTestAgent1 Name of the real test agent.

Default RealTestAgent1

DisableProbeCapacityCheck 1 or 0 Disable the probe capacity check

before running any tests. The
probe can in theory get a lot of
tests. Only disable in very con-
trolled environments.

ProbeDefaultLogin root username to access the Hawkeye

probes for real services test
types. Default root. Will be over-
written by any database settings.

ProbeDefaultPassword Ixia!123 password to access the Hawkeye

probes for real services test
types. Default Ixia!123. Will be
overwritten by any database set-
tings if existing.

Hawkeye Integration Guide xxxviii

Manage configuration file

UseHawkeyeMultiThreading 1 Enable/disable the multithreading

feature of Hawkeye. Only Option
1 is fully supported for versions
6.40 onward. Value 0 is deprec-
ated.

DualGateway 0 Deprecated in 6.80

ProbeHealthCheckPort 10115 Destination port for Hawkeye

health check - Default is 10115.

prioritizeLeftToCompleteMesh 0 If set to 1 will prioritize mesh left

to complete in queue man-
agement. Setting this feature to 1
might be required in complex
mesh scheduling environment to
optimize queuing.

maxOccurencePairs 10000 Defines the maximum number of

pairs that can be executed in a
single chariot test. This takes by
default the limitation based on
the number of license (hence con-
figured as 10000 that should be
more than any other license).
Change this setting to enforce run-
ning tests in smaller occurences
than the license. Recommended
for large scale testing to limit per
tcl concurrency. Consult Ixia sup-
port to tune this parameter.

Note: After all settings were configured, save the con-

figuration file.

xxxix Hawkeye Integration Guide

 Manage configuration file

Hawkeye Integration Guide xl

Apache Server

Apache Server

There are multiple configuration files rooted in the directory /etc/httpd.

The top level configuration file is in /etc/httpd/conf/[Link] and defines the overall
server parameters.

This is where default listening port, Max number of servers, threads, etc. are defined.

recommended settings for the prefork.d section of /etc/[Link] section for large scale
system:

StartServers 8

MinSpareServers 5

MaxSpareServers 10

ServerLimit 64

MaxClients 56

MaxRequestsPerChild 4000

The modular configuration files for plug-ins or namespaces are defined in the directory
/etc/httpd/conf.d.

This is where the Apache namespace for the Hawkeye system is defined. By default, the
configuration file for the Hawkeye namespace is defined in the config file /etc/ht-
tpd/conf.d/80_hawkeye[_namespace].conf.

xli Hawkeye Integration Guide

 Apache Server

The “[_namespace]” is an optional non-root namespace. Normally, the Hawkeye sys-

tem is rooted at the top of the Apache namespace, but it can be placed elsewhere.

When the Hawkeye system is rooted at the top of the Apache namespace, the Docu-
mentRoot configuration value must change in the top level [Link] file to point to the
installation directory.

Another configuration file used by Apache and critical to the Hawkeye system is the
/etc/httpd/conf.d/30_fcgid.conf file.

This defines the configuration of the FastCGI engine of the Apache server that is used to
drive the Web-triggered PHP script processing of the Hawkeye system.

This controls limits and allocations imposed on the FastCGI sub-processes invoked by
the Apache server and are used to tune the system as appropriate for the size of the sys-
tem, number of users and number of probes.

This file is likely to require modifications for installations that larger than the default
installation. Users should consult with Ixia Field support for large systems in order to
tune these values for the requirements of the specific installation.

Recommended settings for /etc/httpd/conf.d/30_fcgid.conf file

FcgidMaxProcesses 480

FcgidErrorScanInterval 30

FcgidZombieScanInterval 30

FcgidBusyTimeout 60

FcgidBusyScanInterval 30

FcgidIdleScanInterval 30

FcgidIdleTimeout 60

FcgidProcessLifeTime 600

FcgidIOTimeout 60

FcgidTerminationScore 1

Hawkeye Integration Guide xlii

Apache Server

FcgidTimeScore 3

xliii Hawkeye Integration Guide

 Hawkeye Services

Hawkeye Services
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.

The “/etc/init.d/Hawkeye” service script is a top level script that runs multiple sub-ser-
vices. Operations performed on the top level Hawkeye script will affect all the sub-ser-
vices specific to the Hawkeye system. This script will run the Daemons/run_
[Link] script which will launch and monitor the sub-services, restarting
any that die unexpectedly. While the script is executable, the user should never directly
run this script (or any of the sub-scripts), but instead only control the top level service
using either the “/etc/init.d/Hawkeye <cmd>” method or the “service Hawkeye <cmd>”
method.

This service along with the web server should be stopped when attempting any sort of
low-level maintenance on the database as they both perform many operations on the
database even on a fundamentally idle system.

The apache service is httpd :

stopping: service httpd stop

starting: service httpd start

All of the Apache and Hawkeye services run as user apache with group apache.

Hawkeye Integration Guide xliv

Hawkeye Services

When both the Apache and Hawkeye services have been shut down, there should not be
any processes owned by the apache user; if there are, then this process is hung and can
be terminated with extreme prejudice.

Additionally, all files in and below the Hawkeye installation directory (normally
/home/ixia/Hawkeye) should be owned by apache to ensure the Hawkeye system
always has control of Its required files.

xlv Hawkeye Integration Guide

 SOAP web services API

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 exten-
sion. It is therefore compatible with any SOAP client and agnostic about the connecting
technology.

It is installed over the same web server than GUI and is listening on incoming request
on port 80.

Hawkeye Integration Guide xlvi

SOAP web services API

It publishes WSDL file format for creating SOAP client connector and publishing all avail-
able APIs.

CAUTION: For security it is recommended to run SOAP

request on https port

Activating SOAP in Hawkeye

In system/Preferences/Advanced Admin section, the following parameters need to be

activated:

SOAP web service API set to 1 or 2 Advanced Setting : Enable server to be

server activation 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 Advanced Setting : IP configuration (used

IP if option 2 when SOAP server IP address restriction
is preferred is configured)
for security

Activating SOAP wsdl file

xlvii Hawkeye Integration Guide

 SOAP web services API

SOAP wsdl file is provided on the following path :

/home/ixia/Hawkeye/WebServer/WebServices/[Link]

so from client it needs to be called from:

[Link]

Modification needs to be done in the [Link] file to get access to the APIs

On Hawkeye server login as root

Edit the following file

/home/ixia/Hawkeye/WebServer/WebServices/[Link]

replace the following line:

<soap:address loc-
ation="[Link] <!-- modify path
to server path -->

with your server access (IP or url) and https instead of http if relevant

Example

<soap:address loc-
ation="[Link] <!--
modify path to server path -->

SOAP API guide

Hawkeye Integration Guide xlviii

SOAP web services API

the following guide list the available API in Hawkeye -

Note the version of the API described below is valid with patch on 2.0 EA version - con-
tact support@[Link] for patch application and latest version of API to be avail-
able.

addProbe
this is used to add a new Probe into Hawkeye. This is only relevant for MAnual probes
therefore should not be needed for any Automatic probes (which are recommended).

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

xlix Hawkeye Integration Guide

 SOAP web services API

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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

1: added

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

Hawkeye Integration Guide l

SOAP web services API

Parameters:

execID: corresponds to test execution ID

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

li Hawkeye Integration Guide

 SOAP web services API

<ns1:checkTestExecutionResultStatusResponse>

<return xsi:type="xsd:string">0</return>

</ns1:checkTestExecutionResultStatusResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

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%")

Hawkeye Integration Guide lii

SOAP web services API

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"

"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"

liii Hawkeye Integration Guide

 SOAP web services API

"IGMP Test"

"Lync Traffic"

"Lync 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"

"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"

Hawkeye Integration Guide liv

SOAP web services API

"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"

"Wifi Connect"

"Wifi Inspect"

"Youtube"

"Youtube Test"

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"

lv Hawkeye Integration Guide

 SOAP web services API

"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"

"Network KPI to->from"

"Audio Stream"

"Video Stream"

"Video from->to"

"Audio RTP from->to"

"Audio RTP to->from"

"Video RTP from->to"

"Video RTP to->from"

"DNS"

"COS 1"

"COS 2"

Hawkeye Integration Guide lvi

SOAP web services API

"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"

"Voice to->from G711"

lvii Hawkeye Integration Guide

 SOAP web services API

"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"

Hawkeye Integration Guide lviii

SOAP web services API

"Video Playback Upshifts"

"Video Quality Segments - High"

"Video Quality Segments - Low"

"Video Quality Segments - Medium"

"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"

lix Hawkeye Integration Guide

 SOAP web services API

"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)"

"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"

Hawkeye Integration Guide lx

SOAP web services API

"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"

"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)"

lxi Hawkeye Integration Guide

 SOAP web services API

"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)"

"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)"

Hawkeye Integration Guide lxii

SOAP web services API

"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"

"Interpacket gap avg (ms)"

"Interpacket gap max (ms)"

"Interpacket gap min (ms)"

lxiii Hawkeye Integration Guide

 SOAP web services API

"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"

Hawkeye Integration Guide lxiv

SOAP web services API

"TVQM average Video bandwidth"

"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)"

"Wifi Signal Level (dBm)"

"Connectivity Status"

lxv Hawkeye Integration Guide

 SOAP web services API

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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>

<urn:PairName></urn:PairName>

<urn:Metric></urn:Metric>

</urn:collectAverageKPIresult>

</x:Body>

</x:Envelope>

output is an array with metrics

exemple

ErrorCode,Passed,Failed,myavg-
value,myvaluemin,myvaluemax,StandardDeviation,totalcount,threshold_min,-
threshold_max,threshold_type

0,1061481,287788,3.10,0.00,1280.00,5.97,1349269,5,8,0.0000

<?xml version="1.0" encoding="UTF-8"?>

Hawkeye Integration Guide lxvi

SOAP web services API

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

<ns1:collectAverageKPIresultResponse>

<return xsi:-
type-
="xsd:string">ErrorCode,Passed,Failed,myavgvalue,myvaluemin,myvaluemax,StandardDeviati
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>

</SOAP-ENV:Envelope>

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:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<x:Header/>

<x:Body>

lxvii Hawkeye Integration Guide

 SOAP web services API

<urn:collectKPI_result>

<urn:tdrID>1666360</urn:tdrID>

</urn:collectKPI_result>

</x:Body>

</x:Envelope>

result:

0 if no idea is found

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-&gt;to" "Passed" "0" "1" "0"

"1666360" "Delay (ms)" "15152" "KPI from-&gt;to" "Passed" "10.43" "100" "0"

"1666360" "Jitter (ms)" "15152" "KPI from-&gt;to" "Failed" "9.57" "5" "0"

"1666360" "Jitter Max (ms)" "15152" "KPI from-&gt;to" "Failed" "15" "5" "0"

"1666360" "Loss" "15152" "KPI from-&gt;to" "Passed" "0" "0.2" "0"

"1666360" "Max loss burst" "15152" "KPI from-&gt;to" "Passed" "0" "2" "0"

"1666360" "MOS" "15152" "KPI from-&gt;to" "Passed" "4.24" "3.7" "1"

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

<ns1:collectKPI_resultResponse>

Hawkeye Integration Guide lxviii

SOAP web services API

<return xsi:type="xsd:string">TDR_ID METRIC PAIR_ID PAIR_NAME STATUS VALUE

THRESHOLD THRESHOLDTYPE

"1666360" "Datagrams Out of Order" "15152" "KPI from-&gt;to" "Passed" "0" "1" "0"

"1666360" "Delay (ms)" "15152" "KPI from-&gt;to" "Passed" "10.43" "100" "0"

"1666360" "Jitter (ms)" "15152" "KPI from-&gt;to" "Failed" "9.57" "5" "0"

"1666360" "Jitter Max (ms)" "15152" "KPI from-&gt;to" "Failed" "15" "5" "0"

"1666360" "Loss" "15152" "KPI from-&gt;to" "Passed" "0" "0.2" "0"

"1666360" "Max loss burst" "15152" "KPI from-&gt;to" "Passed" "0" "2" "0"

"1666360" "MOS" "15152" "KPI from-&gt;to" "Passed" "4.24" "3.7" "1"

</return>

</ns1:collectKPI_resultResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

collectTDR_result
will collect test data result information about test ID

parameter

tdrID: ID of the test result to collect information from

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<x:Header/>

<x:Body>

lxix Hawkeye Integration Guide

 SOAP web services API

<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_com-

ment 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-&gt;to Jitter (ms)

Threshold failed on KPI from-&gt;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"

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

Hawkeye Integration Guide lxx

SOAP web services API

<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-&gt;to Jitter (ms)

Threshold failed on KPI from-&gt;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>

</SOAP-ENV:Envelope>

configureN2NListExecution
use this function to setup a new test for Node to Node (prefer to configure TestEx-
ecution)

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

lxxi Hawkeye Integration Guide

 SOAP web services API

"Network KPI bidirectionnal"

"Network KPI"

"TCP Throughput from->to N streams"

"TCP Throughput from->to 1 stream"

"TCP Throughput to->from 1 stream"

"TCP Throughput to->from N streams"

"TCP Throughput bidirectional"

"UDP Throughput from->to"

"UDP Throughput to->from"

"UDP Throughput bidirectional"

"Voice N Pairs bidirectional"

"Network KPI to->from"

"Network KPI Low Bandwidth"

"UDP Throughput Advanced"

"TCP Throughput Advanced"

"TCP Throughput Optimized Window size"

"Adapative Video"

"Flash RTMP"

"Adaptive video with network quality"

"Netflix"

"Youtube"

"Multicast Video over RTP"

"Lync Traffic"

"Lync Traffic from->to"

"Network KPI Advanced"

"Video Stream"

Hawkeye Integration Guide lxxii

SOAP web services API

"Network KPI 3 COS"

"Voice from->to"

"Voice N Pairs Unidirectional"

"Voice bidirectional"

"COS line qualification"

"Voice N pairs - UDP Data bidirectional"

"Exchange_traffic"

"Traffic Mix - HTTP - Video - Voice"

"HTTP Test"

"HTTPS Test"

"POP3 Response Time"

"SMTP Response Time"

"FTP Response Time"

"SIP Response Time"

"DNS Response Time"

"TCP Response Time"

"UDP Throughput from->to - 4 COS"

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

lxxiii Hawkeye Integration Guide

 SOAP web services API

Use commas between probe names

the probe needs to have an existing and active probe configured into db otherwise will
be ignored

Example : probe3,probe4

OneToOne: value is either 0 (many to many) or 1 (onetoone)

if using the list:

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)

Hawkeye Integration Guide lxxiv

SOAP web services API

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.

IF there is an associated pair (pair_id is not null), the name must be entered with fol-
lowing 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"

lxxv Hawkeye Integration Guide

 SOAP web services API

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 Stream-

s";"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"

Hawkeye Integration Guide lxxvi

SOAP web services API

"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

"Lync Traffic";"numberofpairs";"Number Of Pairs";"0";NULL

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7005";"Audio RTP from->to"

"Lync Traffic";"packetsize";"packet size (bytes)";"7005";"Audio RTP from->to"

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7006";"Audio RTP to->from"

"Lync Traffic";"packetsize";"packet size (bytes)";"7006";"Audio RTP to->from"

lxxvii Hawkeye Integration Guide

 SOAP web services API

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7007";"Video RTP from->to"

"Lync Traffic";"packetsize";"packet size (bytes)";"7007";"Video RTP from->to"

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7008";"Video RTP to->from"

"Lync Traffic";"packetsize";"packet size (bytes)";"7008";"Video RTP to->from"

"Lync Traffic from->to";"numberofpairs";"Number Of Pairs";"0";NULL

"Lync Traffic from->to";"bitrate";"Total bitrate (kbps)";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"packetsize";"packet size (bytes)";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"QOS";"DSCP Setting";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"bitrate";"Total bitrate (kbps)";"7010";"Video RTP from->to"

"Lync Traffic from->to";"packetsize";"packet size (bytes)";"7010";"Video RTP from->to"

"Lync 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 3 COS";"QOS";"DSCP Setting";"17460";"COS 2"

"Network KPI 3 COS";"QOS";"DSCP Setting";"17461";"COS 3"

"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

Hawkeye Integration Guide lxxviii

SOAP web services API

"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

"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 Advanced";"receivesocketbuffer_e2";"receive 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

lxxix Hawkeye Integration Guide

 SOAP web services API

"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

"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 bidirectional";"packetsize";"Packet Size";"0";NULL

"UDP Throughput bidirectional";"QOS";"DSCP Setting";"0";NULL

Hawkeye Integration Guide lxxx

SOAP web services API

"UDP Throughput bidirectional";"bitrate";"Throughput from->to (kbps)";"15161";"UDP

from->to"

"UDP Throughput bidirectional";"bitrate";"Throughput to->from (kbps)";"15162";"UDP

to->from"

"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 from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83002";"UDP from-

>to COS2"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83002";"UDP from->to

COS2"

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83002";"UDP from->to

COS2"

"UDP Throughput from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83003";"UDP from-

>to COS3"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83003";"UDP from->to

COS3"

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83003";"UDP from->to

COS3"

"UDP Throughput from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83004";"UDP from-

>to COS4"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83004";"UDP from->to

COS4"

lxxxi Hawkeye Integration Guide

 SOAP web services API

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83004";"UDP from->to

COS4"

"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

"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"

Hawkeye Integration Guide lxxxii

SOAP web services API

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

lxxxiii Hawkeye Integration Guide

 SOAP web services API

mytestduration: test duration for the execution

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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>

Hawkeye Integration Guide lxxxiv

SOAP web services API

</x:Body>

</x:Envelope>

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)

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<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>

</SOAP-ENV:Envelope>

lxxxv Hawkeye Integration Guide

 SOAP web services API

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 bidirectionnal"

"Network KPI"

"TCP Throughput from->to N streams"

"TCP Throughput from->to 1 stream"

"TCP Throughput to->from 1 stream"

"TCP Throughput to->from N streams"

"TCP Throughput bidirectional"

"UDP Throughput from->to"

"UDP Throughput to->from"

"UDP Throughput bidirectional"

Hawkeye Integration Guide lxxxvi

SOAP web services API

"Voice N Pairs bidirectional"

"Network KPI to->from"

"Network KPI Low Bandwidth"

"UDP Throughput Advanced"

"TCP Throughput Advanced"

"TCP Throughput Optimized Window size"

"Adapative Video"

"Flash RTMP"

"Adaptive video with network quality"

"Netflix"

"Youtube"

"Multicast Video over RTP"

"Lync Traffic"

"Lync Traffic from->to"

"Network KPI Advanced"

"Video Stream"

"Network KPI 3 COS"

"Voice from->to"

"Voice N Pairs Unidirectional"

"Voice bidirectional"

"COS line qualification"

"Voice N pairs - UDP Data bidirectional"

"Exchange_traffic"

"Traffic Mix - HTTP - Video - Voice"

"HTTP Test"

lxxxvii Hawkeye Integration Guide

 SOAP web services API

"HTTPS Test"

"POP3 Response Time"

"SMTP Response Time"

"FTP Response Time"

"SIP Response Time"

"DNS Response Time"

"TCP Response Time"

"UDP Throughput from->to - 4 COS"

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"

Hawkeye Integration Guide lxxxviii

SOAP web services API

"Wifi Connect"

"Wifi Inspect"

"Youtube Test"

isMesh= defines if the mesh option should be used

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

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 - ignored for real services

Use commas between probe names

the probe needs to have an existing and active probe configured into db otherwise will
be ignored

Example : probe3,probe4

Frequency: frequency in minutes you want to run the test with

lxxxix Hawkeye Integration Guide

 SOAP web services API

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.

IF there is an associated pair (pair_id is not null), the name must be entered with fol-
lowing 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

Hawkeye Integration Guide xc

SOAP web services API

"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 Stream-

s";"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"

xci Hawkeye Integration Guide

 SOAP web services API

"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"

"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

"Lync Traffic";"numberofpairs";"Number Of Pairs";"0";NULL

Hawkeye Integration Guide xcii

SOAP web services API

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7005";"Audio RTP from->to"

"Lync Traffic";"packetsize";"packet size (bytes)";"7005";"Audio RTP from->to"

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7006";"Audio RTP to->from"

"Lync Traffic";"packetsize";"packet size (bytes)";"7006";"Audio RTP to->from"

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7007";"Video RTP from->to"

"Lync Traffic";"packetsize";"packet size (bytes)";"7007";"Video RTP from->to"

"Lync Traffic";"bitrate";"Total bitrate (kbps)";"7008";"Video RTP to->from"

"Lync Traffic";"packetsize";"packet size (bytes)";"7008";"Video RTP to->from"

"Lync Traffic from->to";"numberofpairs";"Number Of Pairs";"0";NULL

"Lync Traffic from->to";"bitrate";"Total bitrate (kbps)";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"packetsize";"packet size (bytes)";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"QOS";"DSCP Setting";"7009";"Audio RTP from->to"

"Lync Traffic from->to";"bitrate";"Total bitrate (kbps)";"7010";"Video RTP from->to"

"Lync Traffic from->to";"packetsize";"packet size (bytes)";"7010";"Video RTP from->to"

"Lync 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"

xciii Hawkeye Integration Guide

 SOAP web services API

"Network KPI 3 COS";"QOS";"DSCP Setting";"17460";"COS 2"

"Network KPI 3 COS";"QOS";"DSCP Setting";"17461";"COS 3"

"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

"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 Advanced";"receivesocketbuffer_e2";"receive socketbuffer

e2";"0";NULL

Hawkeye Integration Guide xciv

SOAP web services API

"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

"UDP Throughput Advanced";"filesize";"File Size (bytes)";"0";NULL

"UDP Throughput Advanced";"packetsize";"Send buffer Size";"0";NULL

xcv Hawkeye Integration Guide

 SOAP web services API

"UDP Throughput Advanced";"DestinationPort";"Destination Port";"0";NULL

"UDP Throughput Advanced";"SourcePort";"Source Port";"0";NULL

"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"

"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 from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83002";"UDP from-

>to COS2"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83002";"UDP from->to

COS2"

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83002";"UDP from->to

COS2"

"UDP Throughput from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83003";"UDP from-

>to COS3"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83003";"UDP from->to

COS3"

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83003";"UDP from->to

COS3"

Hawkeye Integration Guide xcvi

SOAP web services API

"UDP Throughput from->to - 4 COS";"bitrate";"Total bitrate (kbps)";"83004";"UDP from-

>to COS4"

"UDP Throughput from->to - 4 COS";"packetsize";"Packet Size";"83004";"UDP from->to

COS4"

"UDP Throughput from->to - 4 COS";"QOS";"DSCP Setting";"83004";"UDP from->to

COS4"

"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

"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

xcvii Hawkeye Integration Guide

 SOAP web services API

"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

"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

Hawkeye Integration Guide xcviii

SOAP web services API

"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

"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

xcix Hawkeye Integration Guide

 SOAP web services API

"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

Hawkeye Integration Guide c

SOAP web services API

"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

"Wifi Connect";"AuthenticationMethod";"Authentication Method";"0";NULL

"Wifi Connect";"SSID";"SSID";"0";NULL

"Wifi Connect";"BSSID";"BSSID";"0";NULL

"Wifi Connect";"Passphrase";"Passphrase (WPA-PSK)";"0";NULL

"Wifi Connect";"UserName";"User name";"0";NULL

"Wifi Connect";"Password";"Password";"0";NULL

"Wifi Connect";"ResetInterface";"Reset interface after test";"0";NULL

"Wifi Connect";"specialWIFIscript";"Captive Portal script (optional)";"0";NULL

ci Hawkeye Integration Guide

 SOAP web services API

"Wifi Connect";"ConnectivityURL";"Ping Address";"0";NULL

"Wifi Connect";"CustomWPA";"Custom wpa content";"0";NULL

"Wifi Inspect";"DestinationServer";"SSID";"0";NULL

"Youtube Test";"DestinationServer";"Video code or url";"0";NULL

"Youtube Test";"Timeout";"Timeout (sec)";"0";NULL

"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

Hawkeye Integration Guide cii

SOAP web services API

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:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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>

ciii Hawkeye Integration Guide

 SOAP web services API

<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.

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

Hawkeye Integration Guide civ

SOAP web services API

<ns1:configureTestExecutionResponse>

<return xsi:type="xsd:string">0</return>

</ns1:configureTestExecutionResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

findProbeIDfromName
find probe ID from inputting name

input: ProbeName as string with name of the probe to look at

<x:Envelope xmlns:x="[Link] xmlns:urn-

n="urn:Hawkeye">

<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.

cv Hawkeye Integration Guide

 SOAP web services API

<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV-
V="[Link] xmlns:ns1="urn:Hawkeye"
xmlns:xsd="[Link] xmlns:x-
si="[Link] xmlns:SOAP-ENC-
C="[Link] SOAP-
ENV:encodingStyle="[Link]

<SOAP-ENV:Body>

<ns1:findProbeIDfromNameResponse>

<return xsi:type="xsd:string">0</return>

</ns1:findProbeIDfromNameResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Hawkeye Integration Guide cvi

Manage users from Active Directory

Manage users from Active Directory

Managing users from active directory is available from Hawkeye.

The settings need to be defined into preferences:

Look for Main section in preferences:

At the bottom of main section the available settings are available:

System authentication mode is either:

- 0 (default): local authentication only. No active directory will be used, no active dir-
ectory server will be used.

- 1: use active directory server with following rule - only existing local users will use the
active directory. That means Hawkeye administrator needs to configure the user in
Hawkeye with same name as defined in Active Directory server and set the user as a
"remote" user - ie not local.

cvii Hawkeye Integration Guide

 Manage users from Active Directory

- 2: user active directory with following rule - at first login, a valid Active directory user
would be able to login and a user will be created into Hawkeye database. The local user
will be created as a remote login user (so checked against the Active directory server)
and with Administration rights in the Administrator group.

Note: when using active directory server the mode 1 is recommended as it allows to
keep control of the access and rights on the platform.

LDAP server address: is the address or URL to reach LDAP or Active Directory server

LDAP domain: is the domain defined for the users.

For configuring users in Hawkeye :

go to Administration/System user management

Edit the user that needs to be enabled with Active Directory authentication.

change the Authentication mode from local to LDAP server.

For each authentication, user credentials will be checked against the LDAP server if
LDAP server mode is configured.

Hawkeye Integration Guide cviii

Manage users from Active Directory

cix Hawkeye Integration Guide

 Index

Index
C

contacting Ixia iv

Ixia, contacting iv

Hawkeye Integration Guide 110