Hawkeye preferences
Hawkeye application is configured through the Preferences screen.
Depending on user level some different configuration options can be accessed.
As system administrator (sysadmin user):
As user:
Change setting
- Change the desired settings in one screen (panel).
-
Save – a confirmation setting has been changed will be displayed.
Most of the parameters changing GUI aspects require a logout / login to be taken into account.
Section “General” for Users
The parameters located in section “GUI Settings” of the configuration file are explained, below.
|
Feature/Setting |
Default Value |
Comments |
|---|---|---|
|
Display Interval Optimiser |
0 |
Will allow schedule enforcing (see section on enforcing schedule in this guide Test Execution) => Disable Interval Optimizer. |
|
Show Server/Client Time |
0 |
Displays time on server to compare to client on top right. Note all times displayed in GUI are translated into CLIENT time. |
|
Default Calendar Range |
LastDay |
This section allows:
It defines the default time scale for the system when user logs in. Recommendation is LastDay or Last Hour for better performance. |
|
Refresh List Timer Value |
120000 |
Refresh table timer (in milliseconds). This will allow refreshing any table with auto refresh option on every defined interval. It is recommended to keep it above 10 seconds for optimized system performance. |
|
Use Droplist Search |
1 or 0 |
In the drop lists there is an automatic search available (in filters). Set it to 0 to disable this and get standard drop lists. |
|
Dashboard Autorefresh |
1 or 0 |
Enable/disable the auto refresh for main dashboard. |
|
Dashboard Autorefresh Interval |
180000 |
Refresh interval for main dashboard (milliseconds). Setting it to lower than 30 seconds can result into big impact on system performance. |
|
Use Droplist Search |
1 or 0 |
In the drop lists there is an automatic search available (in filters). Set it to 0 to disable this and get standard drop lists. |
|
Dashboard Real Test Display |
all |
OPTIONS: all, origin, destination This setting allows the global dashboard to group the real test displays per:
It is recommended to use this setting if there are many tests executed against several destinations. |
|
Maximum lines displayed in Dashboard |
20 |
Main Dashboard displays a maximum number of lines that will be displayed per pages. If there are more lines to display than user specific defined in this parameter, there will be several pages available to browse through results in GUI. |
| Refresh Execution List Timer | 20000 |
Refresh Execution table timer (in ms). This will allow refreshing the execution table with auto refresh option on every defined interval. It is recommended to keep it above 10 seconds for optimized system performance. The refresh window is specific for test execution windows and overwrites the Refresh List Timer Value for test execution related lists (see Test Execution). |
|
Filter on IP format (v4 or V6) for automatic endppoint interfaces |
IPV4only |
Display only interfaces with specific IP format for automatic probes. |
|
Threshold for WiFi signal level in WiFi Dashboard |
50 |
The threshold value for WiFi signals indicating:
|
|
Notification Alerts Silent Mode |
0 |
Silence the notification alerts (bell icon in the top right corner) |
|
Timezone |
UTC |
User Timezone |
Section “Main” for Admins
The parameters located in section “GUI Settings” of the configuration file are explained, below.
|
Feature/Setting |
Default Value |
Comments |
|---|---|---|
| Result Access Control Type | 0 |
Defines how the access to results is controlled. See Group User Management for full details. Value 0: the access control is based on test execution (who executed the test ). Value 1: the access control is based on the probe (if all probes involved in test are available for the user group, the result will be available to the user). |
| Allow Frequency Unit Configuration | 0 | Allow to change the unit for test execution interval set. This will allow to use tests in schedules less than 1 minute. The default value is 0, set it to 1 so scheduling interval unit can be changed. |
| Add Port Numbers to Test Results | 0 | Setting this to 1 will allow all results for Node to Node to be enriched with the port used for the test pairs. |
| Display Test Controller Status | 1 | Displays test controller status into administration table. |
| Map Report | 1 | Setting to 0 will disable Map display. This can be useful if users do not have access to public internet and therefore cannot have access to Google map to display the maps. |
|
Maximum report generation Time |
500 |
Maximum time used to create report – can be changed to allow more time in case of extremely time consuming report creations. |
|
Number of days for database retention |
365 |
In Days Default time for keeping records in database. |
|
Number of days for database retention for detailed metrics |
180 |
Maximum time (days) for keeping detailed records on test results (individual results graphs). |
|
Number of days for database retention of admin elements |
20 |
Number of days of keeping admin details (trail, execution logs, etc.) in the database. |
|
Enforce Complex Password |
0 |
Enforces users to use of mix of letters, numbers for password. |
|
Max Concurrent Tests in GUI |
50 |
Is limitation in GUI of the number of concurrent tests (TCP) or voice calls (RTP). This is pure GUI. Allowing more than pair license will result on test impossible to execute and queuing forever. |
| Registration Server | localhost | IP or hostname of the Registration Server. Registration Server is a component that acts as a mediator between console and endpoints when firewalls exist between them. This should be left to localhost. |
| Allow Auto Registration of Endpoints | 1 | Allow/Block endpoints to register to the console automatically . This can be used for stopping more endpoints to register on the Hawkeye server. |
| Allow Full Range | 1 | Allows to use Full Range time lookup option for database lookup. |
| Display individual result graph time relative or absolute | Relative | Graph time relative or absolute in individual test results. This is for individual test result graph of detailed metrics. The timing can be absolute (exact date) or relative (start at 0s). |
| System Authentification Mode | Local | Mode for Authentication - (Local) Local Authentication only, (LDAP) Local or LDAP authentication [you can use the 'Test LDAP' button in the bottom button bar to test your settings once you save this preference], (Ixia) Ixia credentials when user has been added locally [internet connection required] |
| LDAP server address | LDAP Server (hostname or ip address) or a list of comma delimited servers | |
| LDAP Domain | Domain DN in the format of either example.org or dc=example,dc=org | |
| LDAP - Users Path | The user account folder in the LDAP tree. Example - CN=Users | |
| LDAP - User Attributes | The comma separated list of user attributes to search for and compare the login against in the LDAP element. | |
| LDAP - Enable secure LDAP (LDAPS) | 0 | Enable secure LDAP (LDAPS) |
| LDAP - Auto create Hawkeye user | 0 | Auto create Hawkeye user (if it does not exist already) when Authentication Mode is set to LDAP and user is authenticated successfully |
| LDAP - Enable group based authentication | 0 | Authenticate users based on their existence in the LDAP Group Path specified. |
| LDAP Group Path | Defines the group path as defined in the LDAP tree. (Used only when LDAP group based authentication preference above is set to 1) | |
| LDAP Bind DN | Bind DN for connecting to LDAP. Leave it as empty for anonymous bind. (Used only when LDAP group based authentication preference above is turned on) | |
| LDAP Bind DN Password | Password of LDAP Bind DN. Leave it as empty for anonymous bind (Used only when LDAP group based authentication preference above is turned on) |
Section “GUI” for Administrator
|
Feature/Setting |
Value |
Comments |
|---|---|---|
| Timezone | UTC | User Timezone |
|
Show Server/Client Time |
0 |
Displays time on server to compare to client on top right. All times displayed in GUI are translated into CLIENT time. |
|
Default Calendar Range |
LastDay |
This section allows:
It defines the default time scale for the system when user logs in. Recommendation is LastDay or Last Hour for better performance. |
|
Refresh List Timer Value |
120000 |
Refresh table timer (in milliseconds). This will allow refreshing any table with auto refresh option on every defined interval. It is recommended to keep it above 10 seconds for optimized system performance. |
|
Max records per Page |
50,000 |
Used for reporting long lists and limit the size of the reports (avoid very long report creation). |
|
Allow URL |
1 or 0 |
Set it to 1 to allow probe to have url instead of IP. |
|
Use Droplist Search |
1 or 0 |
In the drop lists there is an automatic search available (in filters). Set it to 0 to disable this and get standard drop lists. |
|
Dashboard Autorefresh |
1 or 0 |
Enable/disable the auto refresh for main dashboard. |
|
Dashboard Autorefresh Interval |
180000 |
Refresh interval for main dashboard (milliseconds). Setting it to lower than 30 seconds can result into big impact on system performance. |
|
Dashboard Real Test Display |
all |
OPTIONS: all, origin, destination This setting allows the global dashboard to group the real test displays per:
|
|
Maximum lines displayed in Dashboard |
20 |
Maximum of entries that will be displayed in Dashboard - restricted to allow quick display. The results can be available clicking on the link in dashboard. |
| Refresh Execution List Timer | 20000 |
Refresh Execution table timer (in ms). This will allow refreshing the execution table with auto refresh option on every defined interval. It is recommended to keep it above 10 seconds for optimized system performance. The refresh window is specific for test execution windows and overwrites the Refresh List Timer Value for test execution related lists (see Test Execution). |
| Map Update Frequency in seconds | 300 | Map update frequency - do not set it with too low value (less than 30 seconds). |
|
Max Idle Time |
3600 |
Maximum session time (maximum time a user session is kept opened before being automatically disabled). Unit is second. |
|
Allow Management from Probe in Probe Management |
0 |
Displays test Controllers status. Only required if multiple controllers are used. |
|
Display Threshold settings on Trend Graphs |
0 |
Set to 1 to display thresholds on trend graphs. |
|
Show Server/Client Time |
0 |
Displays time on server to compare to client on top right. Note all times displayed in GUI are translated into CLIENT time. |
|
Allow Management from Probe in Probe Management |
0 |
Configures availability of remote access button on probes:
|
|
Threshold for Wi-Fi signal level in Wi-Fi Dashboard |
-50 |
Signal levels below this threshold will be displayed as weak levels and levels above this threshold will be displayed as good levels. |
Section “Alarms” for Administrator
|
Alarm Settings |
|
|
|---|---|---|
|
Feature/Setting |
Value |
Comments |
|
SnmpTrapServerIP |
x.y.z.t |
IP address of the SNMP trap server. Default 192.168.174.130. |
|
UseEmailAlarm |
1 or 0 |
Enable/disable the alarms received by email. |
|
UseSNMPAlarm |
1 or 0 |
Enable/disable the alarms received using SNMP. |
|
ConditionalTimeAlarms |
1 or 0 |
Enable/disable the conditional time alarms. |
|
StartAlarmTime |
06:00 |
Value for start time of conditional time alarms. |
|
EndAlarmTime |
23:00 |
Value for end of conditional time alarms. |
Section “Maps” for Administrator
The parameters located in section “MAPS Settings” of the configuration file are explained, below.
|
MAPS Settings |
|
|
|---|---|---|
|
Feature/Setting |
Value |
Comments |
|
UseGoogleMap |
1 or 0 |
Enable/disable the usage of Google Maps. |
|
GoogleMapKey |
|
See below details of how to obtain a Google Map Key. |
|
MapRetentionMinute |
240 |
Number of minutes for the map to look database results. Any results older than this value will not be considered (might result in empty map). |
| Google MAP API URL | Standard | Google MAP API URL - Standard for China location |
Obtain Google Map Key
In order to use the Google map, a key must be generated.
On the following link there are details about the process of obtaining such key: https://developers.google.com/maps/documentation/JavaScript/tutorial?hl=fr#api_key
A valid Gmail account is required in order to generate the key.
Section “Email” for Administrator
|
Feature/Setting |
Value |
Comments |
|---|---|---|
|
SMTP_Server |
|
The address of the SMTP server. |
|
SMTPDebug |
|
|
|
SMTPAuth |
true or false |
True if authentication is used, false if no authentication is configured for the SMTP account. |
|
SMTPSecure |
SSL or TLS |
Configure SSL if Secure Sockets Layer cryptographic protocol is used, TLS if Transport Layer Security protocol is configured for the SMTP account or none if no security is used. |
|
Port |
25 or 465 or 587 |
Configure port 465 for SSL, 587 port for TLS or 25 default SMTP port for no security. |
|
Username |
|
Username of the SMTP account. |
|
Password |
|
Password for the SMTP account. |
|
EmailAddress |
|
The SMTP e-mail address. |
|
FullName |
|
Sender name. |
|
MaxEmailAttempts |
3 |
How many times should the application try to send the message. |
Example of settings for gmail account:
Section “Traffic Port Management” for Administrator
|
Feature/Setting |
Value |
Comments |
|---|---|---|
|
Destination Port Conf Option |
0 or 1 or 2 |
The test controller will increment the port to be used for each test as follows:
|
|
First Destination Port |
10200 |
Destination port for Hawkeye test types start of range. Default 10116. |
|
Source Port Conf Option |
0 or 1 or 2 |
The test controller will increment the port to be used for each test as follows:
|
|
First Source Port |
10216 |
Source port for Hawkeye test types start of range. Default 10216. |
|
Use Skype4B Special Range |
0 |
Use special ports range for Skype4B traffic tests. |
|
Skype4B - First Audio Source Port |
10301 |
Skype4B - First Audio Source Port. |
|
Skype4B - First Audio Destination Port |
10201 |
Skype4B - First Audio Destination Port. |
|
Skype4B - First Video Source Port |
10351 |
Skype4B - First Video Source Port. |
|
Skype4B - First Video Destination Port |
10251 |
Skype4B - First Video Destination Port. |
| Add Port Numbers to Test Results | 0 | 1 to add port used information in all N2N or Mesh tests. Note, one of "Destination Port Conf Option", "Source Port Conf Option" and/or "Use Skype4B Special range" must have the parameter set to "range". |
| Probe Firewall Configure | secure | Applies to visione1s and xr_vm probe types only. Secure = Close all ports / Configure = Disable Firewall and open ports based on Destination Port Conf Option, Destination Ports, Use Skype4B and Voice Spectial Range, Skype4B and Voice Audio Destination Ports, and Skype4B Video Destination Port |
Section “Test Controller” for Administrator
|
Feature/Setting |
Default Value |
Comments |
|---|---|---|
|
Real Test Max Duration |
180 |
Maximum duration of a real test. |
|
Probe Health Check |
1 |
Enable/disable the probe health check engine. |
|
Test E2 Available |
1 |
Test both Endpoint 1 and endpoint 2 availability from Test controller for the test. In network configuration where Endpoint 2 is not available from test controller it might be useful to disable this test. |
|
Probe management identification |
1 |
By default the probe id is used to identify a probe. For some systems where a physical probe has several interfaces. For the resource management to consider same physical probe this option needs to be activated (1) and probes management address set to the same interface (same IP or url). Note that when the Serial number is configured on an endpoint, that is, Web UI Probe Management serial number is not set to blank or ‘default’ for an endpoint, this always takes precedence over the method defined here. |
|
Endpoint Autorestart |
1 |
Enable/disable the auto restart feature for Hawkeye endpoint. If enabled the endpoint will auto restart at AutorestartIntervalMinutes. |
|
Endpoint Autorestart Interval |
360 minutes |
Interval for the endpoint auto restarts time. |
|
Autorestart Max Duration
|
30 |
Maximum duration of autorestart process. |
|
Real Service Port |
22 |
Port required by the test agent to connect to the probes to run real services test types. |
|
Alarm on Probe Status Change |
0 |
Enable alarms (email or SNMP) when probe becomes not available. Send alarm when status changes (available/not available). |
|
Alarm on Probe Health Fail |
0 |
Send an alarm when probe is not available (every check). |
|
Probe Default Login |
root |
Probe default Login - overridden by probe specific configuration. |
|
Probe Default Password |
Ixia!123 |
Probe default Password - overridden by probe specific configuration. |
| Clock synchronization between endpoints | Auto |
To report UDP and RTP statistics, such as, One-Way Delay, Jitter, VoIP MOS and Video Delay Factor, it is necessary for IxChariot to know the difference between the clocks of the sending and receiving endpoint. When Auto is selected, the endpoints use a proprietary algorithm, involving exchanging UDP packets over the UDP port 10115, to evaluate the clock difference. This algorithm is reasonably accurate and its error (which is somewhere between the reported statistics Estimated Error and Maximum Error) is generally between few milliseconds and tens of milliseconds. Occasionally, when a firewall blocks the UDP port 10115 or the network experiences high data loss, the endpoints are unable to synchronize their clocks through this method. This algorithm is increasingly inaccurate on asymmetric connections, where data travels faster in one direction than in the other. The External option assumes the endpoints have been synchronized through some external method (such as manual clock setting or NTP) to have the same local time. It is a way to avoid the limitations of the Auto method. |
| Endpoint Management QoS | None |
Apply QoS template to the management traffic generated by the Endpoints to/from Hawkeye server and other endpoints. This will not apply to test traffic. Supported options are:
|
| Report N2N delay metrics in microsecond resolution | 0 | Report N2N delay metrics in microsecond resolution for metrics like Delay and Video Delay Factor. Values are displayed in the UI as milliseconds with microsecond decimal resolution. Warning: versions of endpoint older than 10.0 build 200 do not support this feature and tests with those endpoints will error with a corresponding error message. |
Section “Advanced Options” for Administrator
|
Feature/Setting |
Default Value |
Comments |
|---|---|---|
|
Report Header Image |
images/reportheader.gif |
Customize the report header image by changing the reference to the gif image. The gif image needs to be placed into the installation folder. (see admin manual for report folder, typically c:/ixia/Hawkeye/main/webserver/images.) |
| Probe Busy | 0 or 1 |
|
| License Reporting Threshold | 0 |
|
|
Use Mesh |
1 |
|
|
Maximum time processing Node to node or mesh test |
200 |
Advanced Setting : safety timer - maximum time (seconds) system waits before trashing node to node or mesh test - do not set below 120 seconds. |
| Maximum time processing real service test | 120 | Advanced Setting : safety timer - maximum time (seconds) system waits before canceling Hawkeye test - do not set below 60 seconds. |
|
Use probe configuration Script for node to node real services |
0 |
Advanced Setting : allow optional use of probe configuration script before and after tests. |
| Maximum pairs per test controller instance | 500 | Advanced Setting : maximum pairs in each controller instance - this setting is only taken into account if controllers are configured with ability to control same probe at same time with different times. |
|
Allow probes to run NodetoNode and real services at same time |
0 |
Advanced Setting : Allow probes to run NodetoNode and real services at same time. Can result into inaccurate test results as tests can interfere with each others. |
| Real Services: default interval time for automatic endpoints | 5 | Advanced Setting : refresh time for automatic endpoints - default is 5 seconds. |
| Real Services: default retry time for automatic endpoints | 0 | Advanced Setting : retry time for automatic endpoints - default is 0 seconds (immediate retry). |
| Disable Real Services and Autoregistration for Automatic Endpoints | 0 | Stop Responses to Automatic Endpoints - do not run any tests nor register new information or endpoints. |
| Test Controller: Polling Interval | 4 | Advanced Setting : Polling interval time in seconds for Test Controller - default is 4 seconds. |
| Maximum number of graphs in a saved or scheduled Report | 100 | Maximum number of graphs that will be created for a saved or scheduled report - setting this to higher than 2000 can impact system performance and delay or cause failure in report generation. |
| Set Test IP that matches Default Gateway (Mesh tests only) | 0 | Applies to Mesh tests on XR automatic endpoints with multiple network connections. When this flag is not enabled, eth0 is used for traffic, if flag is enabled, traffic will use network connection that matches the Default Gateway in Probe Management |
| Wifi Connect Test Execution Interval (minutes) | 5 | Only one Wifi Connect Test per endpoint will be executed in this configured interval window |
| Tests count before setting Auto Learned Threshold | 25 | Advanced Settings: tests counter. Specify the number of tests running in learning phase before setting auto-learned threshold for a metric. Note auto-learn threshold must be turned ON to use this setting. |
Section “Installation Paths” for Administrator
Section “IxProbe” for Administrator
|
Feature/Setting |
Value |
Comment |
|---|---|---|
|
IxProbe Auto Upgrade |
Disabled |
Disable/Schedule/Enable auto upgrade global flag for IxProbes |
Section “Logs” for Administrator
|
Feature/Setting |
Value |
Comments |
|---|---|---|
|
Database Debug |
1 or 0 |
Enable/disable debug on database. |
|
Page Setup Debug |
1 or 0 |
Enable/disable debug on page setup. |
|
Page Action Debug |
1 or 0 |
Enable/disable debug on page action. |
|
Debug JavaScript |
1 or 0 |
Enable/disable debug on java script. |
|
Log Retention Minutes |
240 |
How long the application logs will be retained. |
|
Test Engine Log Retention Minutes |
1440 |
Log retention for underlying test engine - need to be more than 240 minutes. The engine logs are located in C:\Ixia\HawkeyePro\log_chariot. |
| Log Max Age days | 1 | Remove rotated logs older than X days |
| Log Rotation Interval | Daily | Log files are rotated when they grow bigger(daily/weekly/monthly/yearly) |
Section “Test Engine” for Administrator
This section allows configuration of the C:/opt/hawkeye/conf/configTestEngine.txt file on the server.
|
Parameter Name |
Default Value |
Description |
|---|---|---|
|
lowsendjitter |
0 |
Enables low send jitter algorithm on probes. It allows probes to generate UDP or RTP traffic in an optimized way to avoid any bursty traffic. This parameter should be set to 1 to enable the feature. It is very useful in case of testing Class of Services or traffic shapers that can be sensitive to bursts. |
|
maxWait |
60 sec |
Maximum time waiting for Hawkeye test engine to finish the test (on top of test duration + Statistics receive timeout). |
|
maxInit |
60 sec |
Maximum time waiting for Hawkeye test engine to initiate the connection. |
|
autoNAT |
0 |
Needs to be set to 1 in order to allow probes to be managed behind NAT (their address are configured as Public IP from console). Setting this parameter to 1 will allow console to manage the probes behind NAT. Port forwarding still needs to be put in place on the probe NATing to allow management (10115) and traffic (configuration in Test controller section). |
|
ForceE2managementInBand |
0 |
Setting this parameter to 1 will force the management traffic between E1 and E2 to be in band. Console initiates connection on management interface but management between endpoints is in band. This option is required for specific installation. |
|
ConsoleBehindFirewall |
1 |
This needs to be set to 0 in case of using multiple threads in parallel. Constraint is console needs to be able to be directly connected to probes (ie not behind a firewall/NAT). |
|
ALLOW_PAIR_REINIT |
1 |
Activate probe pair setup retry capability. Useful in unstable network for management. Setting up this to 1 might create side effects on probes if tests are executed in volumes. |
|
PAIR_REINIT_MAX |
3 |
Numbers of tries before giving up. WARNING Setting this parameter to 0 will cause test engine to fail all execution. |
|
PAIR_REINIT_RETRY_INTERVAL |
100 sec |
Interval for retrying. WARNING Setting this parameter to 0 will cause test engine to fail all execution. |
|
ALLOW_PAIR_REINIT_RUN |
0 |
Activate traffic retry capability during test. Useful in unstable network for traffic in case of TCP. Setting up this to 1 might create side effects on probes if tests are executed in volumes. |
|
PAIR_REINIT_MAX_RUN |
3 |
Numbers of tries before giving up. WARNING Setting this parameter to 0 will cause test engine to fail all execution. |
|
PAIR_REINIT_RETRY_INTERVAL_RUN |
100 sec |
Interval for retrying. WARNING Setting this parameter to 0 will cause test engine to fail all execution. |
| Statistics receive timeout | 30 sec | The timeout controls how long to wait for statistics until giving up and considering the test traffic connection failed. Error (CHR0529) is reported for the test traffic connections that do not report any statistics for the configured timeout duration. |
Section “VisionE1S” for Administrator
|
Feature/Setting |
Value |
Comment |
|---|---|---|
|
Set as Start Page |
Main Dashboard |
Landing page after login is Main Dashboard/VisionE1S |