Orch UserGuide R952
Orch UserGuide R952
Support
For product and technical support, contact support at either of the following:
1.800.943.4526 (toll-free in USA and Canada)
+1.408.941.4300
www.silver-peak.com/support
We are dedicated to continually improving our products and documentation. If you have
suggestions or feedback for our documentation, send an e-mail to [email protected].
What’s New 25
Orchestrator 9.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Adaptive DDoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
AppExpress Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Availability KPI Improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Cluster Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
DDoS Statistics for Firewall Protection Profile . . . . . . . . . . . . . . . . . . . . . 26
IPS Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
IPv6 SLAAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
LAN-Side EC-V Connectivity to AWS Transit Gateway and Cloud WAN . . . . . . . 26
Stateful-SNAT Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
VXLAN UI Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Other Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Other Topic Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Getting Started 28
Supported Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Guidelines for Creating Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Overview of SD-WAN Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Menu Options 32
Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Orchestrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Monitoring > Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Health Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Disable Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Customize Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Alarm Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Alarm Recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Additional Alarm Indications . . . . . . . . . . . . . . . . . . . . . . . 42
3
Using SD-WAN Orchestrator — 9.5.2 December 20, 2024
NAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
NAT Rules and Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
NAT Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
NAT Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
VRRP Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
VRRP Configuration Considerations . . . . . . . . . . . . . . . . . . . . . . . 315
VRRP Edit Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
VRRP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
WCCP Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
WCCP Edit Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
PPPoE Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
USB LTE Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Understanding RSSI Values . . . . . . . . . . . . . . . . . . . . . . . . 324
Technical Tips and Best Practices . . . . . . . . . . . . . . . . . . . . . 325
Enable or Edit a USB LTE Modem . . . . . . . . . . . . . . . . . . . . . 325
Loopback Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Loopback Orchestration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Create a Loopback Interface . . . . . . . . . . . . . . . . . . . . . . . 329
Change the Subnet IP for a Loopback Pool . . . . . . . . . . . . . . . 330
Reclaim Deleted Loopback IP Addresses . . . . . . . . . . . . . . . . 330
Virtual Tunnel Interfaces (VTI) . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
VTI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Add a VTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Edit a VTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Delete a VTI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
DHCP Server Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
DHCP Settings / Router Advertisements . . . . . . . . . . . . . . . . . 335
V4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
V6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
DHCP Leases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
DHCP Lease Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
DHCP Failover Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
DHCP Failover Settings Examples . . . . . . . . . . . . . . . . . . . . . . . . 344
Single DHCP Failover Group Example . . . . . . . . . . . . . . . . . . 345
Two DHCP Failover Groups Example . . . . . . . . . . . . . . . . . . . 345
DHCP Failover Fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
DHCP Failover Primary or Secondary Roles . . . . . . . . . . . . . . . 347
DHCP Active and Backup Server Behavior . . . . . . . . . . . . . . . 347
DHCP Database Synchronization . . . . . . . . . . . . . . . . . . . . . 347
FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
DHCP Failover State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
DHCP Failover State Descriptions . . . . . . . . . . . . . . . . . . . . 349
Link Aggregation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Configure Link Aggregation . . . . . . . . . . . . . . . . . . . . . . . . 351
Add or Modify a Channel Group . . . . . . . . . . . . . . . . . . . 352
Delete a Channel Group . . . . . . . . . . . . . . . . . . . . . . . 353
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Configure a RADIUS or TACACS+ Server . . . . . . . . . . . . . . . . . 743
Authenticate Using RADIUS or TACACS+ . . . . . . . . . . . . . . 743
Configure an OAuth Server . . . . . . . . . . . . . . . . . . . . . . . . 744
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Register Orchestrator as an App . . . . . . . . . . . . . . . . . . 744
Configure OAuth Server Properties in Orchestrator . . . . . . . 745
Configure a JWT Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Configure a SAML Server . . . . . . . . . . . . . . . . . . . . . . . . . 749
SAML and Orchestrator Configuration . . . . . . . . . . . . . . . 750
API Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Cloud Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Secondary Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Air-Gap Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Enable Air-Gap Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Register Air-Gap to Orchestrator . . . . . . . . . . . . . . . . . . . . . 758
Upload Air-Gap Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Orchestration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Set Maintenance Mode Using the Menu Available from the Appli-
ance Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Set Maintenance Mode Using the Orchestrator Menu . . . . . . . . 762
Tunnel Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
IPSec Suite B Presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
IKE Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
IPSec Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Orchestrator Blueprint Export . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Brand Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Orchestrator > Software & Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Upgrade Orchestrator Software . . . . . . . . . . . . . . . . . . . . . . . . . 773
Upgrade On-Prem Orchestrator . . . . . . . . . . . . . . . . . . . . . 773
Upgrade via HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Upgrade via SCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Upgrade Orchestrator in the Cloud . . . . . . . . . . . . . . . . . . . 775
Check for Orchestrator and Appliance Software Updates . . . . . . . . . . 775
Back Up on Demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Schedule Orchestrator Backup . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Schedule Stats Collector Backup . . . . . . . . . . . . . . . . . . . . . . . . . 778
SMTP Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Orchestrator HTTPS Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Timezone for Scheduled Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Orchestrator Advanced Properties . . . . . . . . . . . . . . . . . . . . . . . . 783
Change the Orchestrator Log Level . . . . . . . . . . . . . . . . . . . . . . . 784
Minimum Severity Levels . . . . . . . . . . . . . . . . . . . . . . . . . 784
24
What’s New
This page provides brief descriptions of new features in the recent Orchestrator release and
links to additional information.
Orchestrator 9.5.2
The following features and updates are included in the user guide for Orchestrator 9.5.2.
NOTE: Some of these features were included in the Orchestrator 9.5.0 or 9.5.1 release but are
documented for the first time in Orchestrator 9.5.2.
Adaptive DDoS
Users can now configure automatic baseline learning for Firewall Protection Profiles. The
Adaptive DDoS feature also includes baseline reporting and two new DoS Threshold settings:
Auto Rate Limit and Smart Burst. See Firewall Protection Profiles, Flow Baselines, and Flow
Baseline Trends.
AppExpress Enhancements
Several improvements were made to AppExpress functionality, including the addition of re-
ports to better illustrate Quality of Experience for AppExpress applications. Additionally, users
will find that popular applications already have their AppExpress settings prepopulated. Fi-
nally, AppExpress is now reflected in the Flows tab and Business Intent Overlays tab. See
AppExpress Summary Tab and Flows - Active and Recent.
25
Using SD-WAN Orchestrator — 9.5.2 December 20, 2024
Cluster Manager
Users can now synchronize user identity information between EdgeConnect appliances. Iden-
tity information is derived from NAC, GPID, and RADIUS snooping. Identity information is used
to set QoS, firewall policies, and SD-WAN steering decisions based on Role, Username, or De-
vice Type. The Cluster Manager also provides visibility and orchestration for the Flow Redirec-
tion feature. See Clusters and Cluster Profiles.
IPS Enhancements
Several enhancements were made to the EdgeConnect Intrusion Prevention System (IPS), in-
cluding the ability to preserve default rule actions of signatures in Signature Profiles and con-
trol automatic signature updates from Cloud Portal. See Intrusion Detection/Prevention Sys-
tem and Signature Profiles.
IPv6 SLAAC
This feature implements Stateless Address Auto Configuration (SLAAC) IPv6 addressing of
ECOS Gateway WAN interfaces, along with stateless DHCPv6. Additionally, users can now as-
sign an alias IP to VLANs. See Deployment Tab.
Stateful-SNAT Exceptions
This feature disables Stateful-SNAT source NATing for specific IP addresses or subnets found
on the LAN-side of the EdgeConnect. This can be useful when the upstream service provider or
web application allow-lists a specific public IP address or subnet other than the EdgeConnect’s
assigned WAN-side IP address. See System Template and System Information.
VXLAN UI Enhancements
Several enhancements have been made to the Orchestrator UI to make VXLAN configuration
and reporting easier, including new fields on the Routes tab to support static VXLAN for local
routes and a new Details column on the VXLAN tab to provide information on the VXLAN’s
state. See Routes Tab and VXLAN Tab.
Other Updates
The “Boost” feature has been renamed to “WAN Optimization” wherever it is used in the Or-
chestrator application. For instance, the Boost tab is now the WAN Optimization tab. The
functionality remains the same.
• Supported Browsers
• Guidelines for Creating Passwords
• Overview of SD-WAN Prerequisites
Supported Browsers
Orchestrator and the Appliance Web user interfaces support the following browsers:
We recommend that you use the latest version available for your browser.
28
Using SD-WAN Orchestrator — 9.5.2 December 20, 2024
Including a new appliance into the SD-WAN fabric consists of two basic steps:
1. Registration and discovery. After you Accept the discovered appliance, the Configu-
ration Wizard opens.
2. Provisioning. Because the wizard prompts you to select profiles, it is easier to create
these ahead of time.
The following figure shows the process of installing and provisioning an appliance for SD-
WAN.
31
Menu Options
All of Orchestrator’s monitoring and configuration options are organized into five main menu
groups, or tabs, located at the top of the main screen, including the following:
• Monitoring
• Configuration
• Administration
• Orchestrator
• Support
Monitoring
The options under the Monitoring tab focus on reports related to performance, traffic, and
appliance status. Additionally, Threshold Crossing Alerts are helpful in monitoring your net-
work.
Configuration
The options under the Configuration tab focus on how to configure Orchestrator. The options
available under this menu are organized as follows:
Administration
The options under the Administration tab are related to appliance administration. They
include general settings, software management, and tools for troubleshooting and mainte-
nance.
32
Using SD-WAN Orchestrator — 9.5.2 December 20, 2024
Orchestrator
The options under the Orchestrator tab are used for managing Orchestrator itself. These
options do not relate to managing appliances.
Support
The options under the Support tab can be used when working with Support to facilitate open-
ing a case or providing Support with data and reports needed to troubleshoot network is-
sues.
Monitoring
The options under Monitoring focus on performance, traffic, and appliance status. Addition-
ally, Threshold Crossing Alerts are helpful in monitoring your network.
Categories include the following:
• Summary
• Reporting
• Bandwidth
• Tunnel Health
Dashboard
Monitoring > Summary > Dashboard
The Dashboard integrates information from multiple components—or widgets—into a uni-
fied display for monitoring your network. It displays appliance license information, topology,
health map, top talkers, top domains, and so forth, on one tab. The collection of widgets are
customizable and persist for each user account.
Topology
Monitoring > Summary > Topology
The Topology tab provides a visual summary of your Silver Peak network.
When configuring a software-defined WAN (SD-WAN), you can view All Overlays, individual
Business Intent Overlays (BIOs), or the single and bonded Underlay tunnels that support
them.
You can access it under Monitoring in the menu bar, or by clicking the widget title on the
Dashboard tab.
Topology widget on Dashboard tab
• The Topology map can dynamically geolocate an appliance when you enter a location
(City, State, Country) in an appliance Configuration Wizard, or when you modify the ap-
pliance by right-clicking to access its contextual menu.
• The map tile renders to support variable detail at different zoom levels.
• You can use icon grouping to visually consolidate adjacent appliances. The status bub-
bles up, and you can configure relative grouping distance in the map’s legend. The group-
ing is also a function of how far you zoom in or out.
• Rolling over an individual appliance’s icon displays basic system information.
When the icon is encircled by a ring, indicating an alarm, those also display.
Health Map
Monitoring > Summary > Health Map
The Health Map provides a high-level view of your network’s health, based on real-time mea-
surements of network conditions between appliances.
• View filters are available for alarms, packet loss, latency, jitter, MOS (mean opinion score),
and Business Intent Overlay.
• The health map can be sorted by weekly, daily, hourly health, or tree (by group, and then
alphabetical by hostname).
• Each block represents one hour and uses color coding to display the most severe event
among the selected filters. Color codes correspond to alarm severity and thresholds.
• Clicking a color block displays a pop-up with specifics about that event, what value trig-
gered it, and any additional threshold breach for that appliance during the same hour.
• While filter and sort order customizations persist for each user account, threshold set-
tings apply globally.
• Threshold settings are not retroactive. Setting new thresholds does not redisplay histor-
ical data based on newly edited values.
• Deleting an appliance deletes its data.
• If you are using overlays, note the following:
Alarms Tab
Monitoring > Summary > Alarms
This tab displays the Alarms table, which provides details about both appliance and Orches-
trator alarms.
Each entry in the Alarms table represents one current condition that could require human
intervention. Because alarms are conditions, they can come and go without management
involvement.
While merely acknowledging most alarms does not clear them, some alarm conditions are set
up to self-clear when you acknowledge them. For example, if you remove a hard disk drive, it
generates an alarm; after you replace it and it finishes rebuilding itself, the alarm clears.
You can filter the alarms listed in the Alarms table.
• Time: 1h, 4hr, 1d, 7d, or Custom. Custom enables you to specify a range of dates in the
Range fields.
• Active: All uncleared alarms. Acknowledged alarms go to the bottom of this list.
• History: Filtered to show only cleared alarms.
• All: All uncleared and cleared alarms.
NOTE: Orchestrator keeps a history of alarms for 7 days. If you are using the on-prem version
of Orchestrator you can configure it to keep a history for more than 7 days. If you are using
Orchestrator-as-a-service, this cannot be changed.
The Alarms tab also includes the following functionality:
• Alarm Emails ON and Alarm Emails Paused: You can enable or disable if you want to
receive an email if there is an alarm that is on or paused.
• Alarm Email Recipients: Each configured recipient can receive emails about either Ap-
pliance alarms or Orchestrator alarms. Click Add Recipient in the Alarm Recipients
window. Select the appropriate type of alarm from the Alarm Type drop-down list, and
then select the check boxes (Critical, Major, Minor, Warning) for which you want to
receive emails. Click Save or Reload.
• Wait to Send Emails: You can customize the amount of time you want the system to
wait to send you an email notifying you of an alarm. Click this button to open the Wait
to Send Emails dialog box, and then enter the number of minutes you want the system
to wait. Click Save.
• Export: You can export a CSV file of your alarms.
• Ack, Acked By, and Acked Time: These columns in the Alarms table indicate whether an
acknowledgment has been received between devices.
– Acked By: The name of the appliance that did the acknowledgment.
– Acked Time: The time when the acknowledgment was received by the appliance.
Disable Alarms
You can specify which alarms you want to disable by clicking Customize / Disable Alarms,
which opens the Alarm Information dialog box.
To disable alarms:
Customize Alarms
Complete the following steps to customize a pre-existing alarm.
1. Select the edit icon next to the selected appliance in the Alarm Information window.
2. Choose Enable/Disable.
3. If selecting Enable, specify the Custom Severity by choosing from the list: None, CRIT-
ICAL, MAJOR, MINOR, WARNING.
4. If selecting Disable, the following message will display: *You are about to disable this
alarm. Click Save.
Alarm Severity
Orchestrator has four severity levels for alarms:
• Critical (red): Critical alarms are service-affecting and require immediate attention. They
reflect conditions that adversely affect an appliance or indicate the loss of a broad cate-
gory of service.
• Major (orange): While service-affecting, major alarms are less severe than critical alarms.
They reflect conditions that should be addressed in the next 24 hours. An example would
be an alarm caused by an unexpected traffic class error.
• Minor (yellow): Minor alarms are not service-affecting and can be addressed at any time.
Examples include alarms caused by a user who has not changed their account’s default
password, a degraded disk, or a software version mismatch.
• Warning (blue): Warning alarms are not service-affecting. They warn of conditions that
could become problems over time—for example, an alarm caused by IP SLA being down.
Alarm Recipients
Complete the following to add alarm recipients to receive an email notifying you of an alarm
within your network.
• The Alarm Type is Orchestrator for Orchestrator alarms, and Appliance for
appliance-generated alarms.
• Groups display in a drop-down list, based on the groups configured in the navigation
pane.
• By default, alarms are HTML Formatted. However, you can choose Plain Text or
Both.
• Plain Text alarms are emailed as pipe-separated data. Users can create a script to
parse the email and read the fields.
Example:
Hostname|Alarm_Status|Time|Alarm_ID|Type_ID|Source|Severity|
Description|Recommended_action
Orchestrator|1|1526341365000|94|6815775|orchestrator|MINOR|Backup con-
figuration not set|
Orchestrator|1|1526341362000|93|6815762|orchestrator|MAJOR|Orchestrator
is using the default SMTP settings
• The Alarm ID is the auto-incremented, primary key in the database.
• Alarm Status: 0 - Cleared | 1 - Raised
List of Alarms
This topic provides lists of alarms related to EdgeConnect appliances and Orchestrator.
NOTE: The tables in this topic use the decimal numeral system for Alarm ID. You can convert
these numbers to the hexadecimal numeral system if you have applications that can do their
own filtering, such as SNMP.
Appliances can raise alarms based on issues that occur with tunnels, software, equipment,
and Threshold Crossing Alerts (TCAs). TCAs are visible on the appliance but are managed by
Orchestrator.
Tunnels
System Type 0 (Appliance); Source Type 1 (Tunnel)
In Appliance Manager:
Administration > Basic Settings
> License & Registration
In Orchestrator: Configuration
> Overlays & Security >
Licensing > Licenses
65544: Tunnel has invalid source IP Appliance TRUE TRUE
CRITICAL address.
Recommended Action:
Delete the tunnel and
re-create it with a valid IP
address.
65545: Tunnel received an Appliance TRUE TRUE
CRITICAL unmatched GRE packet.
Recommended Action: Check
for tunnel encapsulation
mismatch. On the Tunnels
page, go to specified tunnel
and verify both tunnel peers
are using the same
encapsulation method.
65536: Tunnel is misconfigured. Appliance TRUE TRUE
MAJOR Recommended Action:
System ID is not valid. Was
appliance registration
completed?
65546: Tunnel is in reduced Appliance TRUE TRUE
MAJOR functionality.
Recommended Action:
Tunnel peers are not running
the same release of software.
This results in reduced
functionality. Run the same or
compatible software releases
among the tunnel peers.
Software
System Type 0 (Appliance); Source Type 4 (Software)
Equipment
System Type 0 (Appliance); Source Type 3 (Equipment)
Check IP/mask on
EdgeConnect appliance and
router. Next hop should be
only a single IP hop away.
To troubleshoot, use:
show cdp neighbor,
show arp,
and
ping -I <appliance IP> <next-
hop IP>
Orchestrator Alarms
Orchestrator can raise alarms based on issues with tunnels, software, and equipment.
Tunnels
System Type 100 (Orchestrator); Source Type 1 (Tunnel)
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Service
Alarm ID: Affect-
Severity Alarm Text Source ing Clearable
Software
System Type 100 (Orchestrator); Source Type 4 (Software)
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Equipment
System Type 100 (Orchestrator); Source Type 3 (Equipment)
Alarm Service
ID: Affect-
Severity Alarm Text Source ing Clearable
Filter Description
Firewall Drops
Monitoring > Security > Firewall Drops
You can use the Firewall Drops tab to view the statistics on various flows, packets, and bytes
dropped or allowed by a zone-based firewall for a given time range.
• You can select a range of time (in hours and days) to view the firewall drops. You can
also select to view in Matrix or Table view.
• Select Export to export the report to an excel spreadsheet.
• If segmentation is enabled, you can specify the Source Segment and the Destination
Segment to search for the flows, packets, and firewall drops in that segment.
• In the Charts column, you can select the chart icon.
• In this pop-up, you can see packets, and bytes dropped or allowed by a zone-based fire-
wall for a given time range.
You can customize the chart settings using the controls at the top of the tab, as follows:
Option Description
Time period Click a predefined time period (1h, 4h, 1d, 7d) to
display statistics over the last hour, four hours,
day, or seven days.
• Segment: Select a Segment and Zone combination to see the statistics related to the
threshold configured and mapped to the selected segment and zone combination in the
Firewall Protection Profile mapping. If a Firewall Protection Profile is not mapped to a
segment and zone combination, charts for this segment and zone will not be shown.
• Zone: Select a Segment and Zone combination to see the statistics related to the thresh-
old configured and mapped to the selected segment and zone combination in the Fire-
wall Protection Profile mapping. If a Firewall Protection Profile is not mapped to a seg-
ment and zone combination, charts for this segment and zone will not be shown.
• Metric: Select Flows per second, Concurrent flows, or Embryonic flows to see the
corresponding statistics. If a threshold for the selected metric is present in the Firewall
Protection Profile, relevant drops and violation count charts are shown. If the threshold
for the selected metric is not present, only the peak chart is shown.
• IP Protocol: Select All, TCP, UDP, or Others to see the corresponding statistics. If a
threshold for the selected protocol is present in the Firewall Protection Profile, relevant
drops and violation count charts are shown. If the threshold for the selected protocol is
not present, only the peak chart is shown.
You can customize the chart settings using the controls at the top of the tab, as follows:
Option Description
Time period Click Real Time to enable live statistics for all
available interfaces.
Flow Baselines
Monitoring > Security > Flow Baselines
The Flow Baselines tab shows the baseline data computed in the previous interval for the
selected appliance. The data is refreshed after each baseline computation interval. These
charts are only available if you have enabled baseline learning for the appliance.
[
The first set of charts shown includes the following:
• Appliance flow utilization – Indicates used and unused flow capacities. If Smart burst is
configured, unused indicates the spare capacity that can be used by Smart burst.
• Segment flow utilization – Shows how flow capacity is disbursed across the segments.
• Segment-zone flow utilization – Shows flow capacity use for all zones in a segment.
Individual charts that show the baseline data for each configured segment are also shown.
The segment charts show the most recent baselines computed for each protocol within each
segment zone. By default, the charts show baseline data for concurrent flows at the source
level. To see baseline data for other network statistics, select the following filters to customize
the data on the individual segment charts.
• Classification: Filter to show data by either the source level (Source) or the zone level
(Zone).
• Metric: Select the metric to use for stats (Flows per second, Concurrent flows, or Em-
bryonic flows).
You can toggle the individual segment data between Chart View and Table View. When using
Table View, the following columns appear in the table.
Column Description
Column Description
You can customize settings for all the data using the controls at the top of the tab, as follows:
Option Description
[
All Protocols – This chart shows the historical baseline data that was computed at each interval
for all protocols. By default, it uses the Concurrent flows metric and shows data for the default
segment and zone. Use the filters above the chart to view this data for other segments or zones
and using various metrics.
All Zones – This chart shows the baseline data for all zones within a segment. By default, it uses
the Concurrent flows metric and shows data for the default segment and all protocols. Use the
filters above the chart to view this data for a different segment and for various protocols.
All Segments – This chart shows the baseline data for a particular zone across all segments.
By default, it uses the Concurrent flows metric and shows data for the default zone and all
protocols. Use the filters above the chart to view this data for a different zone in the segment
and for various protocols.
All Segments and Zones – This chart shows baseline data for all segments for all zones. By
default, it uses the Concurrent flows metric and shows data for all protocols. Use the filters
above the chart to view this data for various metrics and protocols.
Select the following filters to customize the data shown on the charts.
• Segment: Select the name of the segment from the drop-down menu.
• Zone: Select the name of the zone from the drop-down menu.
• Metric: Select the metric to use for stats (Flows per second, Concurrent flows, or Em-
bryonic flows).
You can customize the chart settings using the controls at the top of the tab, as follows:
Option Description
Availability
Monitoring > Performance > Availability
Use the Availability tab to view HPE Aruba Networking SD-WAN infrastructure availability
data measured as a percentage where uptime (total time minus downtime) is divided by total
time.
NOTE: To use the Availability feature, you must enable New Stats Collection. You should also
discontinue legacy stats collection. For more information, see Stats Collector Configuration.
The Availability tab provides tables for five categories of availability data: Network Role Avail-
ability, Service Availability, Transport Availability, Interface Availability, and Reachability. For
descriptions and details, see Availability Tables below.
By default, percent availability is shown as an aggregate of up to 50 reachable appliances you
select in the appliance tree. To view percent availability by individual appliances, click Show
by Appliance.
Reporting intervals are based on day, week, or month based on your selection. Data is not
presented in the last 24-hour rolling format, but according to a calendar day, calendar week
(Sunday through Saturday), or calendar month. Data will not yet be available on the tab if the
entire day, week, or month selected has not elapsed.
Availability data provided on this tab is calculated based on the availability time zones and
business hours configured for your appliances. If the business hours of operation are currently
set to 24 hours, you might want to adjust them so that availability data better reflects your
business operations. For example, perhaps you use a generator to power your network. At
night, the generator shuts off. You would want to exclude those downtimes from availability
calculations. Click Availability Time Settings in the tab header to configure each appliance’s
business hours and time zone.
NOTE: If you leave the business hours set for 24-hour availability, one minute of downtime is
one minute over 24 hours. If you set business hours to 8 hours, then one minute of downtime
is over those 8 hours. That one minute of downtime counts as a higher percentage because
you are only calculating it over 8 hours of business hours versus 24 hours.
Currently, this feature does not monitor availability for unified fabric tunnels.
This feature does not calculate availability for clusters/sites or EdgeHA pairings. Appliances
are treated as individual entities.
To export the data displayed on the tab to a CSV file, click Export.
Availability Tables
On the Availability tab, availability tables for Network Role, Service, Transport, Interface, and
Reachability (that is, between Orchestrator and your appliances) present their respective up-
time statistics. To display availability data for one or more of these tables, click the corre-
sponding buttons at the top of the tab.
IMPORTANT: Renaming interface labels affects the calculation of availability statistics.
Instances of “No Data” in the tables indicate that no representative data exists. The following
two examples assume that Show by Appliance is selected at the top of the tab.
• If “No Data” is displayed in the Local Breakout (Internet) column of the Service Availability
table for an overlay, the overlay does not have local breakout as one of its transport
options.
• If “No Data” is displayed in a service-related column (such as Zscaler Cloud) in the Service
Availability table for an appliance, the appliance does not subscribe to the service.
Table Description
Click the info icon for Services to open the Tunnels Availability
dialog box, which shows the availability of tunnels related to
services. Click a chart icon for a listed tunnel in this dialog box to
view tunnel availability trends.
Service Availability Provides service availability data by overlay for SD-WAN Fabric,
Local Breakout (Internet), and individual services as defined in
the BIO, such as HPE SSE Cloud and Zscaler Cloud.
Chart and info icons are displayed in the Service Availability table
if Show by Appliance is selected at the top of the tab.
Click the info icon for a service to open the Tunnels Availability
dialog box, which shows the availability of tunnels related to the
service. Click a chart icon for a listed tunnel in this dialog box to
view tunnel availability trends.
Table Description
Click the info icon for a service to open the Tunnels Availability
dialog box, which shows the availability of tunnels related to the
service. Click a chart icon for a listed tunnel in this dialog box to
view tunnel availability trends.
Interface Availability Provides availability data by appliance interface label. The
appliance references the interface label to check interface
status. (Policies are specified according to labels.) Interface
availability does not distinguish between an administrator
setting an interface down and the interface being down. It also
does not reflect the uplink status for the radio component of an
LTE modem.
Table Description
Column Description
Column Description
Target QoE The quality of experience (QoE) target for the application. This target
is what the system assesses the Ping QoE and User QoE against to
determine the best path for each application.
User QoE An Apdex score that is based on actual user flows. When users start
using an application that is monitored, the EdgeConnect begins
measuring the user flows to that application. This is a real-time QoE
measure and is the basis for all the AppExpress decisions to redirect
flows from one transport to another, for the application.
To view trends for User QoE, click the chart icon in this column to
open the QoE Trends chart. For information about the data shown
on the chart, see QoE Trends.
Current Transports The transport(s) that the application is currently using. Current
transports can include third-party IPSec tunnels, local breakout
labels, and SD-WAN peers.
Application The trend of how the traffic flow for this application has performed
Performance trend over time.
Column Description
Status Indicates if the traffic flow for this application on this appliance is
meeting the optimal targets set for this application. Possible statuses:
Ping Suboptimal – No User flows have been observed and there are
no paths whose Ping QoE meets the Target QoE. User flows will be
routed to the path with the highest Ping QoE.
User Optimal – User flows have been observed and are meeting the
Target QoE. New user flows will be routed to the path shown in the
Current Transports column until the User QoE no longer meets the
Target QoE.
User Suboptimal – User flows have been observed; however, they are
not meeting the Target QoE over the Current Transports. At the next
User QoE interval, AppExpress will try the next best transport path
sorted by Ping QoE score.
Fallback – No user flows have been observed and pings to all paths
are failing. AppExpress will revert to standard BIO handling for new
flows.
Ping QoE An Apdex score that is based on synthetic polling. Failed connections
count toward the F boundary. Synthetic polling consists of pings that
go out from an EdgeConnect appliance through the loopback
interface for the appliance across each path. From these pings, the
system determines the Ping QoE for each flow.
To view trends for Ping QoE, click the chart icon in this column to
open the Ping QoE Trends chart. For information about the data
shown on the chart, see Ping QoE Trends.
QoE Trends
To view QoE trends (User QoE and Ping QoE) for traffic for an application that is monitored
and steered using AppExpress, click the chart icon in the User QoE column for an appliance to
open the QoE Trends chart. This chart displays trends for up to 20 applications.
• AppExpress must be enabled for the application for data to appear in the chart.
• The vertical axis of the chart is labeled using the EdgeConnect QoE ratings. These are
fixed values of Excellent: 100-93, Good: 92-84, Fair: 83-64, and Best-Effort (<68).
• Displays the per-minute average of User QoE and Ping QoE for the current path.
• If the User QoE falls below the Target QoE, the flow is put on the next best path. When
the path changes, the chart visually reflects the change with a yellow vertical band and
a gray diamond. If you hover over the gray diamond, a text box indicates the Old Path
and the New Path, as shown in the following figure.
• AppExpress must be enabled for the application for data to appear in the chart.
• The vertical axis of the chart is labeled using the EdgeConnect QoE ratings. These are
fixed values of Excellent: 100-93, Good: 92-84, Fair: 83-64, and Best-Effort (<68).
• Displays the per-minute average of Ping QoE for all possible paths on an appliance.
• The trends for each path are displayed as a separate chart within the window.
• If the Ping QoE falls below the Target QoE for a path, the chart is highlighted in yellow.
About AppExpress
For most enterprises, a handful of high-profile, high-impact applications drive the business.
AppExpress allows you to optimize the user experience for high-impact applications. With
AppExpress you can monitor the traffic flow for up to 50 applications and leverage synthetic
polling and real-time user traffic observations to intelligently steer traffic. AppExpress auto-
matically selects the best path for each of the 50 applications. See Determining the Best Flow
for an Application Path and Transport Types for more information on how AppExpress does
this. AppExpress works for internal and cloud-based applications.
AppExpress sends synthetic probes across all available paths—local breakout, backhaul, and
third-party service tunnels—to applications and it determines which path appears to have the
best latency and is most robust. AppExpress then places flows for applications on the best
paths based on criteria that are set for each application.
The following example shows how AppExpress works for a common application, Zoom,
throughout a typical business day.
Prerequisites
Before you begin using the AppExpress feature you must:
– See Loopback Orchestration and navigate to Configuration > Networking > Loop-
back Orchestration in Orchestrator.
• Configure Stats Collector.
– Distributed Stats Collector is required for AppExpress reporting and monitoring to
fully function.
– See Stats Collector Configuration.
• Enable AppExpress for each application that you want to monitor and steer.
– See Application Definitions and navigate to Configuration > Templates & Policies
> Applications & SaaS > Application Definitions in Orchestrator.
– When enabling, select the Monitor and Steer option.
• Create AppExpress groups and add AppExpress applications to the groups.
– If AppExpress is enabled for an application, but it isn’t added to an AppExpress group
then only monitoring of the application takes place. If you want AppExpress to also
steer the application traffic, it must be part of an AppExpress group.
– See AppExpress Groups Tab, and Apply AppExpress Groups Tab and navigate to
Configuration > Templates & Policies > Applications & SaaS > AppExpress
Groups in Orchestrator.
• For Target QoE, failed User flows and failed synthetic pings contribute to the Frustrated
bin.
• Apdex is calculated for flows once at the start of the flow.
• See https://www.apdex.org for more information about Apdex.
In AppExpress, the T and F boundary thresholds are the two User Experience Thresholds that
you set when you add a new application definition. To do this, navigate to Configuration
> Templates & Policies > Applications & Saas > Application Definitions and click +Add
New Application. For more information about application definitions and setting the QoE
measures for an AppExpress application, see Application Definitions.
Ping QoE
The Ping QoE is an Apdex score that is derived from synthetic probes (ICMP echo-
request/response, TCP connect, HTTP, or HTTPS) that are sent across all available paths. For
each AppExpress application, the system compares the Ping QoE against the Target QoE, to
determine which path best meets the Target QoE, and then the flows for that application are
put on that path.
User QoE
When users begin using an application, the system gathers data based on the real-time flows
for the application. The User QoE is an Apdex score that is derived from these observed user
flows. The system compares the User QoE against the Target QoE, and if the real-time flows for
an application are no longer meeting the Target QoE, the system begins hunting for a different
path that can meet the Target QoE. This process is continuous while an application is in use.
NOTE: AppExpress uses LAN to WAN flows to calculate User QoE and to gather application per-
formance data. TCP and UDP flows are analyzed for User QoE determination. ICMP and other
IP types are not supported by AppExpress. Also, EdgeHA flows are ignored by AppExpress.
Transport Types
There are three transport types that are handled by AppExpress.
Local Breakout
All Primary labels are considered. For information on Primary labels, see the Break Out Lo-
cally Using These Interfaces, Available Interfaces, and Link Selection section in Business Intent
Overlays.
Third Party Service Tunnels
This includes SSE integrations such as Zscaler or Netskope. Services created using Service Or-
chestration are also included. All primary tunnels are considered. This means that AppExpress
tries both the primary and secondary POPs (point of presence) for Zscaler, Netskope, etc. See
the configuration information for Zscaler and Netskope.
Backhaul via BIOs to Hubs
AppExpress selects the backhaul peer based on the lowest peer priority configured, and it does
not consider route metric or administrative distance. When no peer priority is configured, no
paths are searched. AppExpress does not support passthrough paths. Up to 6 backhaul peers
are supported.
Waterfall
In waterfall mode, the system infers which internet breakout link is performing the best at
that moment and it fills the link up with traffic until it reaches 80% then it routes the traffic
to the next best link. Orchestrator uses the data gathered about the links through inference,
the Rank Links By setting, and an algorithm to determine what is the best path to the internet
through each of your labels. During link selection it also applies any performance thresholds
you have set. If the primary link exceeds any of the thresholds, the system waterfalls the traffic
to the next link.
The following figure shows an example of how Waterfall mode is applied and how it infers the
best path to the internet.
In this example the following applies based on the Link Selection settings:
• INETA has the lowest inferred latency, so use INETA for internet breakout
• Route traffic to INETB when INETA reaches 80% or when INETA exceeds any performance
thresholds
• Exclude any links that have an inferred loss greater than 10% or an inferred latency
greater than 500ms
• If all links exceed the performance thresholds, use the next item in the Preferred Policy
Order list. If there is no Preferred Policy entry beneath Local Breakout the traffic will be
dropped.
– In this example, if all labels exceed the performance threshold of 100ms of latency,
the traffic will backhaul because “Backhaul Via Overlay” is listed beneath Local Break-
out in the Preferred Policy Order.
Balanced
In balanced mode, Orchestrator uses weighted round robin and it distributes the traffic across
the links evenly proportional to the amount of bandwidth on each interface. It determines
the ratio based on the amount of bandwidth on each interface. You can set performance
thresholds for loss, latency, and jitter, and if a link exceeds any threshold it is excluded from
the available links.
• Link Selection provides a session-affinity feature that pins all flows between an internal
IP and an internet IP to the same Local Breakout label. Once an initial label is selected by
the Link Selection mechanism, all flows between source and destination IPs stick to the
same label until all flows between the two hosts are inactive for 2 minutes. Performance
Thresholds override session-affinity.
• To see why a label was selected for a flow, refer to the Internet tab of the Flow Details.
The “Best internet link choice reason” item shows why the Link Selection feature pinned a
flow to a given label. In this example, “MOS” was configured in the Rank Links By section
of the Link Selection settings.
The following table describes the possible Best internet link choice reasons.
Reason Description
MOS Ranking of the links is done using the MOS (mean opinion
score) quality attribute.
low-loss Ranking of the links is done using loss.
Low-latency Ranking of the links is done using the latency attribute.
Manual No attribute is used to do the ranking, it follows the order
configured by the user.
Session-affinity The flow took the path of an earlier flow with the same
src+Dst IP because that flow was started within the last
60s.
brownout-limit-crossed One or more more links crossed the brownout threshold.
In-house-metric Ranking of the links is done using an in-house (auto) metric
tunnel-down The passthrough tunnel was momentarily down, so it was
skipped.
No-primary-link No primary links were found after ranking because either
none were configured or all of the links crossed
performance thresholds.
primary-bwfull The bandwidth for all primary links crossed the
performance threshold.
no-backup-link No backup links were found after ranking because either
none were configured or all of the links crossed
performance thresholds.
bkup-bwfull The bandwidth for all backup links crossed the
performance threshold.
fallback-to-next-policy All primary and backup links are browned out or blacked
out, so it moves to the next preferred-policy.
all-links-blackout All primary and backup links are blacked out.
Application Performance
Monitoring > Performance > Application Summary
This tab displays application performance data for up to 50 applications. It reflects a real-time
measure of latency per flow. The Application Performance column displays latency measures
for Client Network Delay (orange), which is from the EdgeConnect to the client-side of the flow,
and for Server Network Delay (blue), which is from the EdgeConnect to the server-side of the
flow.
Latency is calculated using three different metrics. Each of these metrics are reflected on the
Application Performance tab:
– Represents the latency measured between the client and the EdgeConnect branch.
– Corresponds to “Network to Client Delay (CND)” data on flow details.
– Represents the latency measured between the EdgeConnect hub and a server.
– Corresponds to “Network to Server Delay (SND)” data on flow details.
The latency metrics displayed on the Application Performance tab are taken from the flow
details for each flow. To view flow details, go to Monitoring > Flows > Active & Recent Flows,
then click the info icon for any flow, and click Performance to view application performance
data.
The Client Network Delay and Server Network Delay metrics differ when you’re viewing data
for an EdgeConnect at a branch versus data for an EdgeConnect at a hub that connects to a
server.
When viewing data for an EdgeConnect at a branch, the Client Network Delay (orange) rep-
resents a smaller portion of the total delay. The graphic below depicts how each metric is
measured for an EdgeConnect at a branch.
When viewing data for an EdgeConnect at a hub, the Client Network Delay (orange) represents
a larger portion of the total delay. The graphic below depicts how each metric is measured for
an EdgeConnect at a hub.
To view latency trends for an application over time, click the Historical Charts icon. The Appli-
cation Trends tab opens and displays a chart for the application.
Application Trends
Monitoring > Performance > Application Trends
This tab displays application latency trends over time for up to 20 applications. Real-time
latency measurements are charted for both Client Network Delay (orange), which is from the
EdgeConnect to the client-side of the flow, and Server Network Delay (blue), which is from the
EdgeConnect to the server-side of the flow.
You can specify what you want to include in your reports: appliances, data granularity (daily
or hourly) for non-availability reports, traffic type, and types of charts to include. You can
indicate whether the report should be regularly scheduled or be a single report with a custom
time range. You can also specify email recipients for the report.
For availability reports, you can specify data granularity (daily or monthly). You can also indi-
cate whether availability reports should include data for individual appliances or aggregated
data (for up to 10 selected appliances). Availability reports are generated based on availability
time settings you set up. For details, see Availability Time Settings.
Reports and statistics can help you isolate problems, investigate questions, or perform analy-
ses. Orchestrator reports fall into two broad categories:
• Statistics related to network and application performance. These provide visibility into
the network, enabling you to investigate problems, address trends, and evaluate your
WAN utilization.
• Reports related to status of the network and appliances. For example, alarms; threshold
crossing alerts; reachability between Orchestrator and the appliances; scheduled jobs;
network role, service, transport, and interface availability; and appliance reachability.
By default, Orchestrator emails a preconfigured subset of charts every day in a report named
Global Report.
• You can also view current data by clicking the icon associated with a chart listed on the
Schedule & Run Reports tab. The icon associated with the Availability section opens the
Availability tab, which shows availability data related to network role, service, transport,
and interface, and appliance reachability data.
• To view previously generated reports residing on the Orchestrator server, click View Re-
ports at the top of the tab.
Availability reports are generated separately from non-availability reports and are sent sepa-
rately to email recipients as well.
The following table describes various elements on the tab. Use them to create, configure, and
schedule your reports.
Field Description
Field Description
Data Granularity – Time Granularity of the data to report. You can select one or both of
Range the following:
NOTE: Daily and hourly ranges are not available for Health Map
charts. Instead, these charts collect data for seven days for the
day the report is run and for the six days preceding that date.
For example, if you run the report on March 10, it includes data
for March 4 through March 10.
Run Scheduled Report: Click the edit icon. The Schedule dialog
box opens. Click Daily, Weekly, Monthly, or Yearly. Also specify
the appropriate schedule criteria, and then click OK.
TIP: To specify the time zone for scheduled jobs and reports,
navigate to Orchestrator > Software & Setup > Setup >
Timezone for Scheduled Jobs.
Top Maximum number of top reports to include in the report. Select
10, 25, 50, 100, or 1000 from the drop-down list.
Traffic Type Type of traffic to include in the report. Select Optimized Traffic,
Pass-through Shaped, Pass-through Unshaped, or All Traffic
from the drop-down list.
Field Description
Application Charts Application charts to include in the report. Use the drop-down
list at the top of this section to include data for All Overlays, All
Underlays, or a listed overlay.
Tunnel Charts Tunnel charts to include in the report.
Appliance Charts Appliance charts to include in the report.
Availability Availability charts to include in the report.
Availability Granularity Granularity of availability data to include in the report (Daily or
Monthly). Daily is the default setting. This granularity applies
only to availability reports. Availability reports are generated
based on the day or month indicated in the Scheduled or Single
Report section of the tab.
For daily granularity, the report shows availability data for all
days within the start date and end date range.
For monthly granularity, the report shows availability data for all
days within the specified month. If the end of the month has not
been reached, Orchestrator will not generate the report. The
Orchestrator time zone is used to verify that the end of the
month has been reached.
Reports Select to produce availability reports by Appliance (for up to ten
selected appliances) or as Aggregated data (for all selected
appliances; this is the default setting).
Lock Scales for Trends Indicates whether to automatically scale trend charts for
specified scheduled reports or to lock scales. Toggle off to
automatically scale; toggle on to lock scales.
View Reports
Monitoring > Reporting > View Reports
Use this tab to view and download reports in PDF form. Reports can be filtered by keywords
or sorted by name, size, or date last modified. These reports can also be emailed depending
on the configuration set on the Schedule & Run Reports tab.
Sample Report
• It provides a central location for viewing and deleting scheduled jobs, such as appliance
backup and any custom reports configured for distribution.
Overlay-Interface-Transport
Monitoring > Bandwidth > Overlays & Interfaces > Overlay-Interface-Transport
The Overlay-Interface-Transport tab provides the distribution of traffic across three dimen-
sions (overlays, interfaces, and transport), which you can view individually or compared to an-
other dimension by selecting two of the three dimensions. You can display the data in three
ways: pie charts, line graphs, or summary.
NOTE: For IP Alias interfaces, the system does not provide statistics.
For example, select the Overlay and Interface options to see how the overlay traffic is dis-
tributed for your interfaces. You can use the Flip button as a toggle to switch (flip) the display
of the inner- and outer-ring data.
You can also see how much traffic is transported from one EdgeConnect appliance to another
on the SD WAN fabric (Overlays) compared to how much is broken out (local breakout or to
the internet). The Underlay legend displays non-overlay traffic.
• Underlay – Includes traffic that traverses directly over SD-WAN underlay tunnels (exclud-
ing BIO overlay traffic, which also uses these tunnels). For example, if you create a rule
with match criterion application x, and then send it over to New_York_MPLS_MPLS (an un-
derlay tunnel), the traffic is categorized as underlay traffic. In addition, underlay traffic
includes data sent over actual SD-WAN underlay tunnels, generally including the follow-
ing types of control messages:
– Keep alive packets – Appliances use these packets to evaluate the reachability of
remote peers and the health of connections.
– Path characterization (pathchar) – Measures path characteristics (loss, latency, and
jitter) for a specific path or tunnel.
– Any non-BIO traffic sent to non-SD-WAN locations over an encapsulated tunnel (that
is, IPSec or GRE), such as Zscaler.
– Any encapsulated traffic that matches a BIO match criterion sent to a cloud service.
• Passthrough – Includes any non-BIO traffic sent without any encapsulation to a destina-
tion.
• SP Overlay – Includes any traffic sent to SD-WAN peers over BIO-bonded tunnels.
• Breakout (local breakout or to the internet) – Includes any non-encapsulated traffic that
matches a BIO match criterion sent to non-SD-WAN peers.
Option Description
Time period Click Real Time to enable live statistics for all available interfaces.
Click a predefined time period (1h, 4h, 1d, 7d) to display statistics over the
last hour, four hours, day, or seven days.
Click Custom and set your own custom time range to display statistics for
that time period.
Packets/bps Click Packets to display statistics according to the number of packets sent
and received.
Click bps to display statistics for bits per second sent and received.
Show in UTC Click this option to toggle chart times between local appliance time or UTC.
Large Click this option to toggle the size of the charts between smaller (default)
and large.
Lock Scale By default, each chart uses its own scale that is relative to the data
displayed. Click this option to apply and lock the same scale to each chart.
Payload By default, charts show complete bandwidth usage statistics—payload and
also SD-WAN overhead. (SD-WAN overhead includes only tunnel control
packet data.) To view bandwidth usage for payload only, click (enable) the
Payload button.
Interface Summary
Monitoring > Bandwidth > Overlays & Interfaces > Interface Summary
From the Interface Summary tab you can view the Interface Summary Report for one or more
appliances. The report provides a visual representation of various interface statistics, such as
inbound and outbound traffic, firewall denies, average bandwidth utilization, and peak band-
width utilization. You can export the report data to a CSV file. From this tab, you can also view
the Interface Trends Charts that display the report statistics in chart form for easy analysis.
NOTE: For IP Alias interfaces, the system does not provide statistics.
The statistics on the report and charts are summarized for the selected time period.
• On the tab you can view report statistics for one or more appliances at a time, but you
can view the Interface Trends Charts for only one appliance at a time or export the report
for only one appliance at a time.
• The default time range is one hour. You can click a predefined time range (1hr, 4hr, 1d,
or 7d) or specify a custom time range by clicking Custom and entering start and end
dates/times.
• Data can be expressed in packets or bytes. Packets displays statistics according to the
number of packets sent and received. Bytes displays statistics for number of bytes sent
and received.
• To view the Interface Trends Charts for an appliance without leaving the Interface Sum-
mary tab, click the icon in the Trends column for an appliance. The Interface Trends
Charts dialog box opens and displays the charts for the selected appliance. To view the
data in the charts on a larger scale, click Interface BW Trends to open the Interface BW
Trends tab.
[
The following example shows an example Interface Summary Report for 50 appliances ex-
ported on Oct 13, 2023 at 8:42 pm and data expressed in bytes.
[
The previous examples provide two different output formats for the Interface Summary. Both
report formats contain the following:
• Columns that show the total number of bytes sent and received on a particular interface
within a specified time frame.
• Columns that track denied flows for inbound and outbound, which are counted for each
flow that was denied during that period.
• Columns for average bandwidth utilization for inbound and outbound, which are calcu-
lated as follows:
(Total number of bytes received or transferred) ÷ (Duration of the selected interval in
seconds)
The resulting numbers are expressed as percentages of the maximum configured band-
width for that link. These statistics could be less useful if there are several idle periods
within the selected time frame, as the idle periods bring down the averages.
• Columns for peak bandwidth utilization, which is measured as the maximum bandwidth
utilization per second during the selected time frame, as reported by EdgeConnect. This
statistic could be less meaningful if the traffic pattern for the link is mostly idle with oc-
casional bursts up to link speed.
To accurately determine the bandwidth utilization for capacity planning, identify the “busy
periods” during the workday and only use those time frames to calculate the average and
maximum bandwidth utilization. Currently Orchestrator does not have an automated way to
identify busy periods. However, you can use the Interface Trends Charts to get a sense of
this information. To view the Interface Trends Charts, click the icon in the Trends column for
an appliance, as shown in the following graphic, or click Appliance BW Trends to open the
Interface BW Trends tab. For more information see, Interface Bandwidth Trends.
Application Bandwidth
Monitoring > Bandwidth > Applications > Summary
The Application Bandwidth chart shows which applications have sent the most bytes.
• Mousing over the charts and the legends reveals additional information.
• The WAN charts identify what percentage of the bandwidth the EdgeConnect appliance
saved by optimizing the traffic.
Top Talkers
Monitoring > Bandwidth > Identifiers > Top Talkers
This tab lists the IP addresses that use the most bandwidth.
Domains
Monitoring > Bandwidth > Identifiers > Domains
This tab lists the domains that use the most bandwidth.
The number of Subdomains selected determines how the table aggregates subdomains for
display. An asterisk (*) indicates that more subdomains would be displayed if a higher number
were selected. This is not a filter, but rather a grouping convenience.
Countries
Monitoring > Bandwidth > Identifiers > Countries
This tab lists the countries that use the most bandwidth.
Ports
Monitoring > Bandwidth > Identifiers > Ports
This tab lists the ports that use the most bandwidth.
Traffic Behavior
Monitoring > Bandwidth > Identifiers > Traffic Behavior
The Traffic Behavior report identifies and categorizes traffic based on low-level characteris-
tics of the data streams. The behavior types are:
• Voice
• Video Conferencing
• Video Streaming
• Bulk Data Transfer
• Interactive
• Undetermined
You can also specify these categories as match criteria when creating policies or ACLs (Access
Control Lists).
Appliance Bandwidth
Monitoring > Bandwidth > Appliances > Summary
The Appliance Bandwidth chart lists the top appliances based on the total volume of inbound
and outbound traffic before reduction. It shows how many bytes the EdgeConnect appliance
saved when transferring data, aggregated over a selectable time period.
For each Business Intent Overlay, the Link Bonding Policy specified determines the bandwidth
efficiency. To guarantee service quality levels, High Availability requires the most overhead,
and High Efficiency requires the least. Charts show the total bandwidth used. The Payload
option shows how much raw data is transmitted. At the same time, it exposes the Peaks
option, which enables the viewing of peak transmissions.
User Bandwidth
Monitoring > Bandwidth > Users > Summary
The User Bandwidth tab allows you to monitor user bandwidth by viewing a summary of
statistics. This will help you identify which users are consuming the most bandwidth.
NOTE: User bandwidth is derived from RADIUS snooping.
Statistics are summarized for the selected time period. You can change the time period for
which user bandwidth summary data is displayed by using the 1hr, 4hr, 1d, and 7d buttons at
the top of the tab, or click Custom to specify a custom date range and granularity.
User Trends
Monitoring > Bandwidth > Users > Trends
The User Trends tab shows user bandwidth trends over time for selected appliances. In the
appliance tree, select the appliances for which you want to view user bandwidth trends data.
You can select up to 20 appliances.
NOTE: User bandwidth trends are derived from RADIUS snooping.
You can change the time period for which user bandwidth trends are displayed by using the
4hr, 1d, and 7d buttons at the top of the tab, or click Custom to specify a custom date range
and granularity.
Tunnels Bandwidth
Monitoring > Bandwidth > Tunnels > Summary
The Tunnel Bandwidth chart shows the tunnels that are sending the most bytes—that is, the
most active tunnels.
Show Underlays
Underlays are actual IPSec tunnels and physical paths taken (such as MPLS). Overlays are log-
ical tunnels created for different traffic types and policies (such as VoIP).
Traceroute
This shows trace route information between the tunnel source and destination IP addresses.
It shows intermediate hops, their IP addresses, and the latency between each hop.
Live View
Live View shows the live bandwidth, loss, latency, and jitter on all the tunnels. For an overlay,
it also shows live tunnel states—Up, Browned Out, or Down.
LiveView shows in real time how synergy is created to maintain coverage. The real-time chart
shows the SD-WAN overlay at the top and the underlay networks at the bottom. The over-
lay is green and is delivering consistent application performance while both underlays are in
persistent brown-out state.
• Hovering over the charts and the legends reveals additional information.
• The WAN charts identify the percentage of the bandwidth the appliance saved by opti-
mizing the traffic.
NOTE: For one-day statistics, Orchestrator saves statistics at midnight (UTC time) for the pre-
vious day. Therefore, clicking 1d displays data for the entire day preceding midnight (UTC).
For example, if you do this five hours after midnight (UTC), only recently-generated statistics
belonging to the day preceding midnight (UTC) will be displayed. The last five hours will not
be reflected in the pie charts. To display statistics for the last 24 hours, click Custom, select
Hour for Granularity, and then specify the exact 24-hour time range.
• For each Business Intent Overlay, the specified Link Bonding Policy determines the band-
width efficiency.
• To guarantee service quality levels, High Availability requires the most overhead and High
Efficiency requires the least.
• Charts display the total bandwidth used.
• The Payload option shows how much raw data is transmitted. At the same time, it ex-
poses the Peaks option, which enables the viewing of peak transmissions.
NOTE: Underlay tunnels are a shared resource among overlays. Therefore, underlay charts
display aggregated data.
However, if A and B transmit at the same time, Hub could easily be overrun.
If Hub experiences congestion:
• Enable Dynamic Rate Control allows the Hub to regulate the tunnel traffic by lowering
each remote appliance’s Tunnel Max Bandwidth. The smallest possible value is that
appliance’s Tunnel Min(imum) Bandwidth.
Filter Description
Filter Description
DSCP Select the desired DSCP from the list. You can choose any or a
specified DSCP from the list.
Protocol You can specify the protocol you want to apply to your filter. Select
the text field and a list displays. You can select all or specify an
individual protocol to apply.
Domain Includes the domain you can specify to filter your flow. Use the
format **.domain.__ or __.domain.[com, info, edu, org, net,* and
so forth.*]* Select the text field and a list displays. Choose the
domain you want to apply.
Overlay Overlay to which the flow is applied. Overlays are defined on the
Business Intent Overlay tab.
Transport Select any of the three transport types: SD-WAN, Breakout, and
Underlay.
You can also apply a third-party service in this column if you have
one configured.
Flow Characteristics You can apply any of the following flow characteristics to your
flow: WAN Optimization, Directly Attached, IPS Dropped,
Pass-Through, Slow Devices, Route Dropped, Firewall Dropped,
Embryonic, Asymmetric, and AppExpress.
Filter Description
• Click the Src <-> Dest icon (./Media/src-dest-icon.png)) associated with the Segment filter
to toggle between displaying only one Segment field (the either option) and displaying
two fields (source on the left and destination on the right).
• The From:To check box associated with the Zone filter functions similarly. Clear this check
box to display only one Zone field (the either option). Select it to display the From and To
fields.
For a Segment either condition, if the the Zone fields are disabled regardless of
Segment field is set to Any whether you select the From:To check box
For a Segment either condition, if the only one Zone field is enabled (the Zone
Segment field is set to a specific segment either condition) and the drop-down menu
lists zones associated with only the selected
segment; the From and To fields are not
available
If the Segment source and destination fields the Zone drop-down fields are disabled
are both set to Any regardless of whether you select the
From:To check box
If the Segment source field is set to Any, but the Zone either condition does not apply;
the Segment destination field is set to a only the To field is available and the
specific segment drop-down menu lists zones associated with
only the selected segment
If the Segment source field is set to a specific the Zone either condition does not apply;
segment, but the Segment destination field only the From field is available and the
is set to Any drop-down menu lists zones associated with
only the selected segment
If the Segment source and destination fields the Zone either condition does not apply;
are both set to specific segments both the From and To fields are available
and the drop-down menus list zones
associated with only the selected segments
If routing segmentation is disabled in your the Segment filter is not displayed; the Zone
network fields are enabled, but zones that are
associated with only the default segment
are listed in the drop-down menus
Filter Field
You can use the Filter field to configure specific filters. The drop-down menu displays a list of
default filters you can apply to your flows. Click the edit icon to add, edit, or delete filters.
To add a filter:
You can also select the history tab with the two arrows next to the Filter field if you want to go
back to a previously applied filter. A maximum of 20 previously applied filters can be saved.
– Selected flows are individually selected; All Returned results from filtering (up to
the max number of returnable flows); and All refers to all flows, visible or not.
Export
Click Export to save the contents of the Flows table to a CSV file.
Flow Detail
Click the info icon in the Detail column to display information about the flow. This information
is primarily provided to assist Support with troubleshooting and debugging.
Inbound/Outbound Reduction %
The Inbound Reduction % and Outbound Reduction % columns in the Flows table refer to
reduced WAN traffic relative to a specific appliance.
NOTE: These columns are hidden in the Flows table by default. To display them, right-click any
column header in the table to display a list of available columns, and then select the Inbound
Reduction % and Outbound Reduction % check boxes.
All flows in drop state are reset at flow reclassify time, overriding intervals described below.
ICMP/UDP Flows
• For any non-TCP connection (such as icmp, UDP), a flow is deleted only from inactivity.
• The inactivity timeout is three minutes for this type of flow. For example, after a ping
connection is stopped, the flow still appears in the “Current Flows” for three minutes.
This setting can be modified by using the system template.
• For a TCP connection, a flow is deleted under different timeouts. A half-open (single
SYN) connection stays for two minutes if the connection does not establish correctly. A
half-close (single FIN) or unclean-close (RST) deletes the connection after two minutes. A
normal close (FIN-FIN) deletes the connection almost immediately.
• A TCP connection also has an inactivity timeout. If no activity is detected on an estab-
lished TCP connection for 30 minutes (by default), the flow is deleted. This setting can be
modified by using the system template.
• The timers can be modified per sequence number by using the Optimization Template.
– Idle Timeout: The period of time that a TCP connection has to be idle before a keep-
alive is sent. (Default 600 seconds)
– Probe Interval: The time in seconds between each keep-alive probe. (Default 30
seconds)
– Probe Count: The number of times TCP probes the connection to determine
whether it is alive after the keep-alive option has been activated. The connection is
assumed to be lost after sending this number of keep-alive probes. (Default 8)
• Auto Reset Flows - Enables or disables the auto-reset of TCP flows. If a connection is
seen by an appliance but after the handshake already completed, the connection would
normally remain but without TCP Acceleration. If this feature is enabled, and a connec-
tion is reclassified in the Flows report, around 30 seconds later, it will be reset. When
the endpoints re-establish the flow, it now will be subject to the optimization and route
policies it matches. This feature is disabled by default. It can be enabled per sequence
number by using the Optimization Template.
Outbound and Inbound in EdgeConnect refer to the direction of traffic as it flows from the LAN-
side to the WAN-side of an appliance, or from the WAN-side to the LAN-side of an appliance.
These are different from actual interface names, such as WAN0 or LAN0.
DSCP Bandwidth
Monitoring > Bandwidth > DSCP > Summary
The DSCP Bandwidth chart shows the DSCP classes that are sending the most data.
Shaper Summary
Monitoring > Bandwidth > QoS > Shaper Summary
Use this tab to view the Shaper Summary for all traffic classes on selected appliances. The
Shaper delays certain packet types to optimize overall network performance. For more infor-
mation about shaping, see Shaper Tab and Shaper Template.
• Use the controls above the table to specify how much data—time and date range—you
want to see in the summary.
• Use the Top X filter to limit data according to top applications by total traffic bytes. You
can include the top 10, 25, 50, 100, or 1000 applications.
• Click Outbound or Inbound to change the summary by traffic direction.
Field Description
You can change the time period for which to display WAN Optimization statistics. Click the
1hr, 4hr, 1d, or 7d button; or click Custom to specify a custom date and time period in the
Range fields.
Field Description
When an application needs acceleration, the WAN Optimization engine increases throughput
bandwidth to the licensed WAN Optimization amount. For example, if the licensed WAN Opti-
mization limit is 300 Mbps, the engine can accelerate traffic to that amount per second. If the
engine determines that it could accelerate traffic to higher speeds if more licensed bandwidth
were available, it sends 300 megabits in the first second interval, 300 megabits in the next sec-
ond interval, and marks that last interval as having insufficient WAN Optimization. Because
WAN Optimization statistics are recorded on a per-minute basis, it marks the entire minute as
having insufficient WAN Optimization.
Based on a licensed WAN Optimization limit of 300 Mbps:
• Transactional data that requires a transfer of, for example, just 75 MB (600 megabits)
of data would result in the transfer of 300 megabits in the first second interval and 300
megabits in the next second interval with that last interval being marked as having in-
sufficient WAN Optimization. WAN Optimization statistics would indicate one minute of
insufficient WAN Optimization, even though only one second is actually marked as hav-
ing insufficient WAN Optimization. In this case, you probably do not need to increase
your WAN Optimization bandwidth license.
• Continuous transfers of data, such as occurs for backups and replications over a period
of hours or days, require continuous WAN Optimization. In this case, WAN Optimization
statistics, such as Minutes Insufficient WAN Optimization, are more precise than in the
previous transactional data example. For example, if the transfer of 1 terabyte of data
is needed, a licensed WAN Optimization limit of 300 Mbps would be insufficient because
the WAN Optimization engine could speed this up to whatever the link speed allows.
Total WAN Optimization bandwidth available to your network is controlled by your license.
You can purchase additional WAN Optimization bandwidth if needed. If you have licensed
WAN Optimization bandwidth available, you can assign WAN Optimization to appliances on the
Licenses tab or on an appliance’s Deployment page. You can also configure WAN Optimization
allocation by using Business Intent Overlays.
NOTE: Your network uses a single queue for WAN Optimization across all appliances. When
that queue is completely utilized, appliances will have insufficient WAN Optimization for any
additional demand.
The WAN Optimization license functions as a shaper. When the WAN Optimization license is
exceeded, TCP traffic is queued and shaped to optimize the bandwidth. Not having enough
WAN optimization has an adverse effect on TCP applications. It is highly recommended that
you obtain an amount of WAN Optimization equal to your entire WAN bandwidth.
For UDP traffic, not having enough WAN Optimization causes the traffic to be sent un-
optimized. Because optimized UDP traffic involves compression of data, the traffic is sent
uncompressed.
You can identify applications that use the WAN Optimization engine, and then use Access Con-
trol Lists (ACLs) and rules to permit or deny those applications from WAN Optimization. To
identify your top application-related flows, use the Flows tab (Monitoring > Bandwidth > Flows
> Active & Recent Flows) to list flows by total bytes sent.
Increase or decrease WAN Optimization bandwidth by 20%, or set it to a specific value in Kbps.
Click Save to apply changes, or click Cancel to not apply changes and close the dialog box.
Live View
Monitoring > Tunnel Health > Live View
Live View shows the live bandwidth, loss, latency, and jitter on all tunnels. For an overlay, it
also shows live tunnel states—Up, Browned Out, or Down.
LiveView shows in real time how synergy is created to maintain coverage. The real-time chart
shows the SD-WAN overlay at the top and the underlay networks at the bottom. The over-
lay is green and delivering consistent application performance while both underlays are in
persistent brown-out state.
Loss Summary
Monitoring > Tunnel Health > Loss > Summary
The Loss chart shows tunnels that have the most dropped packets. Statistics are summarized
for the selected time period.
Loss percentages, before and after Forward Error Correction (FEC), are determined by data
that the local EdgeConnect observes. Two types of loss are measured:
• Pre-FEC Loss % – Percent of data packets lost before applying FEC / Total sent packets.
This measure indicates what the packet loss would be if FEC were not applied.
• Post-FEC Loss % – Percent of data packets lost after applying FEC / Total sent packets.
This measure indicates what the packet loss is after FEC is applied.
The total number of sent packets over the link is calculated based on three parameters:
Based on the above information, the Pre-FEC and Post-FEC Loss percentages are calculated as
follows:
Loss Trends
Monitoring > Tunnel Health > Loss > Trends
The Loss Trends chart shows tunnel packet loss over time, before and after Forward Error
Correction (FEC).
NOTE: Underlay tunnels are a shared resource among overlays. Therefore, underlay charts
display aggregated data.
Jitter Summary
Monitoring > Tunnel Health > Jitter > Summary
The Jitter chart shows the tunnels that have the most Jitter. Statistics are summarized for the
selected time period. Jitter can be caused by congestion in the LAN, firewall routers, bottleneck
access links, load sharing, route flapping, routing table updates, and timing drifts.
Jitter Trends
Monitoring > Tunnel Health > Jitter > Trends
This tab shows tunnel jitter time.
NOTE: Underlay tunnels are a shared resource among overlays. Therefore, underlay charts
display aggregated data.
Jitter is the variation in the time between packets arriving, caused by network congestion,
timing drift, or route changes. Low jitter values are critical for maintaining the quality of real-
time applications. Interpreting jitter trends in network tunnel traffic is essential for maintaining
the quality and performance of real-time applications such as voice, video, and other latency-
sensitive services.
• Set Baselines: Establish a baseline for acceptable jitter levels based on the requirements
of your applications. For example, VoIP typically requires jitter to be below 30 millisec-
onds for good call quality.
• Monitor Trends: Use monitoring tools to continuously track jitter values over time. Look
for patterns or spikes that deviate from the baseline.
• Identify Patterns: Consistent High Jitter: Indicates chronic network issues such as persis-
tent congestion, poor routing, or inadequate bandwidth.
• Intermittent Jitter Spikes: May suggest temporary issues like traffic bursts, transient con-
gestion, or route flapping.
• Gradual Increase in Jitter: Could indicate a growing network load or emerging congestion
problems that need to be addressed.
• Correlate with Other Metrics: Check other performance metrics such as latency, packet
loss, and throughput to gain a comprehensive understanding of network health. For
example, high jitter combined with high packet loss may indicate severe congestion or
faulty network equipment.
• Analyze Traffic Patterns: Determine if jitter issues correlate with specific times of day,
specific applications, or particular traffic patterns. This can help identify whether the
problem is related to peak usage times or specific application demands.
• Investigate Network Links: Examine the performance of individual network links and
paths. High jitter on a particular link may indicate a need for troubleshooting or recon-
figuration. Consider performing a path trace to identify where jitter is introduced along
the route.
• Quality of Service (QoS) Policies: Ensure that QoS policies are correctly configured and
prioritize real-time traffic. Misconfigured QoS can lead to increased jitter and degraded
application performance. Review and adjust QoS settings as necessary to ensure proper
prioritization and handling of sensitive traffic.
• Capacity Planning: Assess whether your current network capacity meets the demands of
your applications. If necessary, plan for additional bandwidth or infrastructure upgrades
to alleviate congestion and reduce jitter.
• Implement Redundancy and Failover: Ensure that your configuration includes redun-
dancy and failover mechanisms to maintain performance during link failures or conges-
tion. Utilize multiple paths to distribute traffic and minimize the impact of jitter on critical
applications.
• Use Advanced Features: Leverage dynamic path selection and application-aware routing
to optimize traffic flows and reduce jitter.
Latency Summary
Monitoring > Tunnel Health > Latency > Summary
The Latency tab shows summary statistics for latency (transmission delay) on an in-band, end-
to-end tunnel basis for the selected time/date range. Either overlay or underlay tunnels can be
displayed, and anywhere between the top 10 to top 1000 tunnels are displayed by round-trip
time (RTT).
On this tab, latency is a measure of the RTT within a tunnel in milliseconds. Values on the left
display RTT as measured by the local appliance. Values on the right display RTT as measured
by the appliance at the remote end of the tunnel.
Some column descriptions follow:
• Std. Latency – Standard deviation (in milliseconds) of latency values for the tunnel within
the specified period.
Standard deviation is a measure of the amount of variation in a set of values. Low stan-
dard deviation indicates that the values tend to be close to the mean or expected value
while a high standard deviation indicates that the values are spread over a wider range.
• Max Latency (ms) – Maximum RTT value (in milliseconds) for the tunnel within the spec-
ified range.
• Avg Latency (ms) – Average RTT value (in milliseconds) for the tunnel within the specified
range.
High latency can negatively affect throughput in the network, most noticeably for TCP traffic.
Physical distance has the most significant impact on latency. For example:
• If data is crossing the United States, you can expect delays from 60 to 120 milliseconds.
• International transmissions can normally experience delays up to 200 milliseconds.
• Satellite transmissions often have delays of about 1/2 second, and up to several seconds
are possible.
High latency can also be caused by equipment (hop-by-hop delays), or by loss or congestion
resulting from lost packets, lost acknowledgments, and necessary retransmissions.
TCP Acceleration (a function of WAN Optimization) can mitigate the impact of latency on
throughput. In addition, path conditioning and packet re-ordering (a function of Business
Intent Overlay link bonding) can mitigate the impact of loss and out-of-order packets on TCP
throughput by reducing the number of retransmissions.
Latency Trends
Monitoring > Tunnel Health > Latency > Trends
The Latency Trends chart shows tunnel latency over time.
NOTE: Underlay tunnels are a shared resource among overlays. Therefore, underlay charts
display aggregated data.
Average out of order packets over the link is calculated based on three parameters:
Calculations are based on the following formulas. For these calculations, the (SUM_WRX_PKTS)
must be greater than the threshold of 6000 minimum WRX packets. You can configure the
threshold value from the Loss Summary tab.
• Inbound (WAN to LAN) average Out of Order Packets before Packet Order Correction (%)
= SUM_PRE_POC * 100 / SUM_WRX_PKTS
• Outbound (LAN to WAN) average Out of Order Packets after Packet Order Correction (%)
= SUM_POST_POC * 100 / SUM_WRX_PKTS
NOTE: Underlay tunnels are a shared resource among overlays. Therefore, underlay charts
display aggregated data.
The Mean Opinion Score (MOS) is a commonly used measure for video, audio, and audiovisual
quality evaluation. Perceived quality is rated on a theoretical scale of 1 to 5; the higher the
number, the better the quality.
The value can be affected by loss, latency, and jitter. In practice, a value of 4.4 is considered
an excellent quality target.
• The value can be affected by loss, latency, and jitter. In practice, a value of 4.4 is consid-
ered an excellent quality target.
• The Min MOS value reports the worst score within a minute.
Tunnels Summary
Monitoring > Tunnel Health > Other Tunnel Statistics > Tunnels Summary
This tab summarizes tunnel statistics, including reduction, throughput, jitter, latency, and
packet loss. For each Business Intent Overlay, the specified Link Bonding Policy determines
the bandwidth efficiency. The data counts and trannsmission rates can be influenced by the
policies you deploy. To guarantee service quality levels, High Availability requires the most
overhead and High Efficiency requires the least. The table shows the total bandwidth used.
The Payload filter removes overhead from the displayed values. The values reported are for
the time period you specify.
The Tunnels Summary screen includes the columns listed in the table below.
Latency (ms) Reports the average time it took Low latency is crucial for
for a data packet to travel from real-time applications such
one end of the tunnel to the as voice and video
other. communications.
Max Latency (ms) Reports the maximum time it Transient high latency can
took for a data packet to travel cause sporadic degredation
from one end of the tunnel to the of real-time applications
other. such as voice and video
communications.
Configuration
The options under Configuration focus on how to configure Orchestrator.
Categories include the following:
– Policies
– Templates
• Cloud Services
Use the Business Intent Overlays (BIOs) tab to create separate, logical networks that are indi-
vidually customized to your applications and requirements within your network. By default,
there are several predefined overlays matching a range of traffic within your network.
The overlay summary table is used for easy comparison of values between your various con-
figured overlays. You can select any link in the table and the Overlay Configuration dialog box
launches. You can also temporarily save your changes before officially applying those changes
to your overlay. The pending configuration updates are indicated by an orange box around
the edited item. Click Save and Apply Changes to Overlays when you are ready to apply the
changes and click Cancel if you want to delete the changes.
Overview
Orchestrator matches traffic to an ACL, progressing down the ordered priority list of overlays
until it identifies the first one that matches. The matched traffic is then analyzed against the
internet traffic configuration of the overlay and forwarded within the fabric, or broken out to
the internet based on the preferred policy order. If the software determines that the traffic
is not destined for the internet, it refers to the WAN Link Bonding Policy configuration and
forwards traffic accordingly within the overlay.
1. Select the name of the overlay. The Overlay Configuration window opens. If you want
to edit the default overlay or create a new overlay, enter the new name of the overlay in
the Name field.
2. Select the Match field and choose the match criteria from the menu.
3. Click the edit icon next to the ACL field. To apply default ACLs or create your own, click
Add Rule in the Associate ACL window.
4. Click Save.
Region
To view the associated region within your overlay, click Regions in the Region column in the
overlay summary table. To modify, remove, or edit overlay settings for a selected region, select
it from the Region drop-down list at the right-top of the Overlay Configuration window. For
more information about Regions, refer to the help on the tab.
Topology
Select the type of topology you want to apply to your overlay and network. You can choose
between the following types of topology:
• Hub & Spoke: Hubs are used to build tunnels in Hub & Spoke networks and route traffic
between regions. If you choose Hub & Spoke, any appliance set as a hub will serve as
a hub in any overlay applied to it. Hubs in different regions mesh with each other to
support regional routing. To configure hubs, click Hubs at the top of the page.
• Regional Mesh and Regional Hub & Spoke: To streamline the number of tunnels cre-
ated between groups of appliances that are geographically dispersed, you can assign
appliances to Regions and select Regional Mesh or Regional Hub & Spoke.
You can select which WAN interfaces you want to use for each device to connect to the SD-
WAN. First, you assign your traffic to go to the Primary interfaces. If the Primary interface is un-
available or not meeting the desired Service Level Objectives configured, either the Secondary
or Backup interfaces are used depending on what you have configured. You can configure only
Backup interfaces, only Secondary interfaces, or both Secondary and Backup interfaces. Move
the desired interfaces between the Primary, Secondary, and Backup boxes. The interfaces
are grayed out until they are moved into the boxes.
• Cross Connect – Allows you to define tunnels built between each interface label. By
default, tunnels are formed between labels with the same name. For example, if you
have INETA configured on two appliances that are both members of the same mesh
overlay topology, those appliances will be connected via a tunnel over the INETA label.
In most cases there will be more than one internet link at a given site resulting in the
use of INETA and INETB. In this case, it is necessary to cross connect INETA to INETB by
placing both labels into the same group. If both INETA and INETB are configured with
“Group 1” then tunnels will be formed from INETA <> INETB and INETA <> INETA.
• Show/Hide Secondary – Click Show Secondary to display the Secondary box, so you
can drag interfaces into the box to enable Secondary interfaces. If you do not enable
Secondary interfaces, you can click Hide Secondary to close the Secondary box.
• Add Secondary if Primary Are – Specifies when the system should use the Secondary
interfaces. Select either Down or Not Meeting Service Levels. Secondary interfaces will
be used before Backup interfaces if you have you have both configured.
• Add Backup if Above Are – Specifies when the system should use the Backup inter-
faces. Select either Down or Not Meeting Service Levels. If you have Secondary inter-
faces configured, Backup interfaces will be used when both the Primary and Secondary
interfaces are unavailable and not meeting the configured Service Level Objectives.
NOTE: The order that labels appear in the Primary, Secondary, and Backup boxes only mat-
ters when Custom bonding is used and Link Selection is set to “Waterfall” with Rank Links By
set to “Fixed Order”.
Traffic is routed through the primary interfaces exclusively until the Service Level Objectives
(SLOs) for Loss, Latency, or Jitter have been exceeded. If this occurs, backup interfaces are
added to the overlay to help meet the specified SLO.
You should configure SLOs based on the tolerance of the application to network performance.
You should not configure SLOs based on the type of network or expected performance of the
network itself. SLOs are about the application, not the network. For example, for voice SLOs
most customers find 250ms Latency, 50ms Jitter, and 10% Loss to be acceptable parameters.
For High Availability and High Quality “waterfall” overlay modes, when an underlay violates
the Loss SLO, the underlay is not removed from the overlay until the overlay itself violates
the SLO. For High Throughput and and High Efficiency “balanced” modes, when an underlay
violates the Loss SLO it is immediately removed from the overlay. This behavior is controlled
by the Exclude Links BIO setting and can be modified using the Custom link bonding policy.
The Exclude Links setting does not apply to Latency or Jitter SLOs. Those SLOs always operate
with Exclude Links set to “on Underlay Brownout”.
NOTE: If all links are in violation of SLOs, the system acts as if no SLO is configured and all links
are configured as primary.
You can select the following Link Bonding Policies when you need to specify the criteria for
selecting the best route possible when data is sent between multiple tunnels and appliances.
You can also select custom bonding, which enables you to customize link prioritization and
traffic steering policies based on multiple criteria.
Field Description
High Availability High availability chooses the best performing path, uses the path
until it is near full, then waterfalls traffic onto the next best
performing path. All traffic receives 1:1 FEC (forward error correction)
when a copy of the packet is placed on another transport. High
availability link bonding policy type should be used only for real-time
traffic, since it renders the effective bandwidth to 50%.
High Quality High quality policy chooses the best performing path, uses the path
until it is near full, then waterfalls traffic onto the next best
performing path. Adaptive FEC is used to provide parity packets only
if there is degradation of the circuit. High quality link bonding policy
should be used as the default selection for all non-real-time traffic
types.
High Throughput High throughput policy load-balances packets across all transports
performing below the SLO defined in the BIO. Adaptive FEC is used to
provide parity packets only if there is degradation of the circuit. This
link bonding policy is used only in unique circumstances.
Field Description
High Efficiency High efficiency policy load-balances packets across all transports
performing below the SLO defined in the BIO. No FEC is used in this
bonding policy. This link bonding policy is used only in unique
circumstances.
Custom If the current fixed overlay bonding modes are not flexible enough,
the Custom link bonding policy allows for fine tuning your network
performance. Custom link bonding preserves existing bonding
modes (HA, HQ, HT, HE) while allowing customization of link bonding
characteristics on a per-overlay basis. This should only be used when
absolutely necessary. If you select Custom, see the following table for
information about the settings.
If you select Custom link bonding, enter the appropriate information for the following fields.
Field Description
FEC Wait Time Measured in milliseconds (ms). This controls how long to wait
to fill a packet before sending. A lower number indicates more
FEC overhead.
Exclude Links This controls when an underlay is removed from an overlay
during brownout conditions.
NOTE: The Exclude Links setting only applies to the Loss SLO.
When underlays violate a Latency or Jitter SLO they are
immediately removed from the Overlay regardless of the
Exclude Links setting.
Field Description
Link Reorder Frequency This controls how aggressively underlays are evaluated and
determines when to switch traffic from one link to another. It
also controls the ranking and eligibility of links, which impacts
Link Selection and brownout behavior.
Field Description
To further customize your overlay configuration, enter the appropriate information for the
following fields.
Field Description
FW Zone Select the firewall zone you want to restrict traffic to from an
overlay.
NOTE: This field is disabled when end-to-end zone-based
firewall is enabled.
WAN Optimization Select Enabled if you want to apply any purchased WAN
Optimization to your overlay or select Disabled if you do not
want to apply WAN Optimization to your overlay.
Field Description
Peer Unavailable Option Select what the appliance should do when there is no peer
reachable via a tunnel. Select a specific label, Use Best Route,
or Drop. If you select a specific label, the appliance routes the
traffic to that link.
Best Route: When selected, the appliance searches for the next
best route that is available.
You can create different breakout policies for hubs. Any hub you select in the Topology sec-
tion also displays at the top of the Internet Traffic to Web, Cloud Services tab. When you
select an individual hub, the Use Branch Settings displays, selected, to the right of the screen.
Complete the following steps to create a custom breakout policy for that hub:
1. Clear the Use Branch Settings check box.
2. Configure the now accessible parameters.
3. Click OK.
• You can move policies back and forth between the Preferred Policy Order and the Avail-
able Policies columns. You can also change their order within a column. The defaults
provided are Backhaul via Overlay, Break Out Locally, and Drop.
• When you select Break Out Locally, confirm that any selected interface that is directly
connected to the internet has Stateful Firewall specified in the deployment profile.
• You can add services (such as Zscaler, Fortigate, or Palo Alto). The service requires a
corresponding internet-breakout (Passthrough) tunnel for each appliance traffic to that
service. To add a service, select the edit icon next to Available Policies.
• The Default policy you configure for internet breakout is pushed to all appliances that
use the selected Overlay. However, you might want to push different breakout rules to
your hubs.
Break Out Locally Using These Interfaces, Available Interfaces, and Link Selection
• You can select the best internet breakout links by specifying the type of Link Selection;
either Waterfall or Balanced.
– If Waterfall is selected, links are ranked on the selected threshold, from best to
worst, using an inference system that averages performance of all SDWAN fabric
tunnels associated with a given label. In Waterfall mode, flows are routed across the
best label until bandwidth utilization is above 80%. Once 80% utilization is reached
flows will “waterfall” to the next-best label. For more information about Waterfall
mode, see Internet Breakout Trends.
– If Balanced is selected, flows are subjected to a weighted load-balancing algorithm.
The weighting is proportional to the available bandwidth of the link.
– For both Waterfall and Balanced, if a threshold is configured for Loss, Latency, or
Jitter, the system removes the link from Local Breakout eligibility when it exceeds
the threshold.
1. In the Break Out Locally Using These Interfaces section, drag and drop available inter-
faces into the Primary or Backup boxes.
2. Under Link Selection, select Waterfall or Balanced, and enter the amount for the Per-
formance Thresholds: Loss, Latency, Jitter, and Utilization.
3. If you selected Waterfall, select one of the following thresholds to rank links.
Field Description
Auto Default threshold if you do not specify the threshold for your links. The
Auto metric uses combined loss and latency to derive the best link. This is
the same metric used for determining the best underlay in HQ overlay
bonding mode and is referred to as “Overall Quality” in the Link Selection
section of the Custom Bonding configuration.
MOS Inferred average MOS score for a given underlay.
Loss Inferred average loss percentage as derived from the all Up-Active tunnels
for a given underlay.
Latency Inferred average latency for a given underlay.
Field Description
Fixed Order Links are sorted in the order specified under Break Out Locally Using These
Interfaces. The link at the top of the Primary list is used first.
NOTE: Backup links are used only when all primary links are down.
4. Click the edit icon next to Break Out Locally Using These Interfaces to change the default
Local Breakout IPSLA endpoints.
The IP SLA Rule Destination dialog box appears.
5. Click the Enable IP SLA rule orchestration toggle. Then enter information in the fol-
lowing fields to change the default Local Breakout IP SLA endpoints and create IP SLA
rules.
Field Description
Enable IP SLA rule When enabled, Orchestrator automatically sets up IP SLA rules on all
orchestration appliances where this overlay is applied.
Monitor Select one of the three types of probes used to monitor IP SLA
endpoints: Ping, HTTP, or HTTPS.
NOTE: Using HTTPS causes additional CPU load and increased packets
due to the overhead of SSL handshaking. Ping or HTTP are
recommended.
Address A comma separated list of hostnames or IP addresses to probe. A
response from any of the destinations allows the system to validate
the path.
Proxy Address (optional for HTTP/HTTPS)
User Agent (optional for HTTP/HTTPS)
HTTP Request After an HTTP probe is sent, this is the length of time the system waits
Timeout to hear back from the destination server.
Ping How frequently the ping or HTTP/HTTPS probe is sent. This value can
Interval/Polling be set to “1” for ICMP, however, this should be set to “2” or greater for
Frequency HTTP/HTTPS.
Rolling average The rolling average for loss and latency for each destination. For a 1
window for Loss second Keep Alive Interval, this would be a 5 minute rolling average.
and Latency Reducing the sampling window could cause overly aggressive behavior.
Field Description
Reachability The system uses these values to determine if the probe can reach the
destinations or not. A good value for these is 5, based on a 1 second
Keep Alive Interval. Setting these any lower could cause false positives.
Field Description
Loss OR Latency, Select one of two options for combining the Loss and Latency metrics.
Loss AND Latency
OR – The system marks the status of the tunnels as “down” if either the
Loss or the Latency thresholds are crossed.
AND – The system marks the status of the tunnels as “down” if both
the Loss and Latency thresholds are crossed.
Check IP SLA How frequently EdgeConnect checks to see if the thresholds have been
status every crossed. This is also how frequently a decision is made to move a
tunnel in or out of service or to raise an IP SLA Down alarm. 30
seconds is the default. Setting this value much lower could cause false
positives or tunnel flapping.
Apply Overlays
Configuration > Overlays & Security > Apply Overlays
Use this page to add or remove overlays from appliances. If you select Edit Overlays, you
will be redirected to the Business Intent Overlay tab for further customization. You can also
view the status of the overlays if you select View Status.
Interface Labels
Configuration > Overlays & Security > Interface Labels
To make it easier to identify connections, you can create descriptive interface labels for each
link type in your environment. Use labels to match and route traffic into overlays. The label
type specifies “which side” of the network the interface is on. LAN labels identify LAN-side data
(subnets), and WAN labels identify the WAN service, such as MPLS, Internet, or LTE. If you edit
a label, tunnels that reference that labeled interface are renamed accordingly.
• LAN labels can be selected for a traffic access policy in a Business Intent Overlay (BIO),
which in turn is applied to an appliance with those LAN labels. All traffic matching those
interfaces is automatically processed by that BIO. If you use an ACL for a traffic access
policy, the LAN label is ignored for that BIO.
• WAN labels are used by Orchestrator and BIOs to determine which interfaces on dif-
ferent appliances should be connected by tunnels built by Orchestrator. Orchestrator
automatically pushes interface labels to appliances it manages.
Manage Labels
Use the Interface Labels dialog box to manage labels in Orchestrator, available under Config-
uration > Overlays & Security > Interface Labels.
From this dialog box, you can create, edit, or delete labels.
Create a Label
Edit a Label
1. In the Interface Labels dialog box, click the edit icon to the right of an existing label.
2. Select wan or lan for the label type—you cannot change the label type if the label is
currently in use.
3. If you want to change the label name, modify it in the Label Name field.
NOTE: For WAN labels, if you want to allow Orchestrator to build tunnels using this label
in any topology, leave the Topology selection set to any. If you want to override BIO
settings and exclude this label in Full Mesh overlays, set Topology to Hub & Spoke.
IMPORTANT: Renaming interface labels affects the calculation of availability statistics as
provided on the Availability tab.
4. Click Done to save your changes and close the dialog box. Otherwise, click Close to
cancel and return to the list of interface labels.
Delete a Label
1. In the Interface Labels dialog box, click the X icon to the left of a label you want to delete.
NOTE: Labels used in overlays cannot be deleted.
The label is deleted from the list but can be restored by closing the dialog box without
saving.
2. To save your changes and permanently delete the label, click Save.
WARNING: When deleting a label, a confirmation message warns you that deleted inter-
face labels will be removed from all policies, interfaces, and deployment profiles that are
currently using the label.
3. Click Save to confirm the removal. Otherwise, click Cancel to return to the Interface
Labels dialog box.
Hubs
Configuration > Overlays & Security > Hubs
On this tab, you can add, remove, and associate hubs to a specified region within the Re-
gional Mesh or Regional Hub-and-Spoke topologies configured on the Business Intent Over-
lay tab.
You can specify whether a hub will re-advertise routes that were previously received from a
spoke in the hub’s region or a hub in another region.
NOTE: This feature requires appliance software version 9.1.0 or later.
You can also access the Regions tab and Business Intent Overlay tabs by clicking the links at
the top of the page.
Complete the following steps to add a hub:
1. Start typing a name or select the appliance you want make a hub from the list.
2. Select one of the following:
• Re-Advertise Routes – This hub will re-advertise its routes so that other appliances
can learn them. This hub will also re-advertise routes learned from other EdgeCon-
nect appliances within its region.
• Do Not Re-Advertise Routes (Stub Hub) – This hub will not re-advertise routes
learned from other regions or spokes. All local routes (static, directly connected,
BGP, and OSPF) will still be advertised. Hubs that do not re-advertise their routes
are stub hubs.
To delete a hub, select the X icon next to the hub you want to delete.
NOTE: You must remove all overlays before you can revert a hub back to a spoke.
Deployment Profiles
Configuration > Overlays & Security > Deployment Profiles
Instead of configuring each appliance separately, you can create various Deployment Pro-
files and provision a device by applying the profile you want. For example, you can create a
standard format for your branch.
TIP: For a smoother workflow, complete the DHCP Server Defaults tab (Configuration > Net-
working > DHCP Server Defaults) before creating Deployment Profiles.
You can use Deployment Profiles to simplify provisioning, regardless of whether you choose
to create and use Business Intent Overlays.
NOTE: You cannot edit IP/Mask fields because they are appliance-specific.
– Navigate to Configuration > Overlays & Security > Deployment Profiles, click the
Edit icon next to Label, and make the appropriate changes, or
– Navigate to Configuration > Overlays & Security > Interface Labels) and make
the appropriate changes.
• The change you make to a label propagates automatically. For example, it renames tun-
nels that use that labeled interface.
• To customize an individual interface on the Deployment Profiles tab, click the DHCP-
related link under the IP/Mask field. The DHCP Settings / Router Advertisements dialog
box opens.
• Before you can configure DHCP, you must navigate to Management Services and select
an interface for DHCP Relay. See Management Services for more information.
If the LAN interface has an IPv4 IP address, click V4 to display the DHCP configuration settings.
See V4.
If the LAN interface has an IPv6 IP address, click V6 to display the Router Advertisement set-
tings. See V6.
V4
The following tables describe the various DHCP settings you can configure for LAN interfaces
that have IPv4 IP addresses.
DHCP Server
Field Description
Field Description
DHCP failover Enables DHCP failover. To set it up, click the Failover
Settings link.
DHCP/BOOTP Relay
Field Description
Field Description
V6
The following table describe the various router advertisement settings you can configure for
LAN interfaces that have IPv6 IP addresses. The LAN clients can use these options to autocon-
figure IPv6 addresses and to learn default gateway addresses.
NOTE: DHCP for IPv6 is not supported.
Setting Description
Setting Description
Other Flag Select this option to instruct IPv6 hosts to use DHCPv6 to
obtain additional configuration information, such as DNS
server addresses and other network parameters.
Link MTU Set the maximum transmission unit (MTU) size that can be
transmitted without fragmentation. This helps ensure that
all hosts on the network use the same MTU, avoiding issues
related to packet fragmentation and reassembly.
Max Interval Specify the maximum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Min Interval Specify the minimum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Current Hop Limit Set the default hop limit for IPv6 packets sent by hosts on
the network. Hosts use this value to configure their own
hop limit for outgoing packets.
Default Router Preference Select High, Medium, or Low to set the preference level of
the router for use as a default router. Hosts use this value
to prioritize multiple routers on the same link.
Default Router Lifetime Specify the lifetime in seconds of the default route that is
advertised by the router. The hosts use this value to
determine how long the router should be used as the
default gateway.
Reachable Time Specify the time in milliseconds that an IPv6 host considers
a neighbor reachable after receiving a confirmation. This
value maintains accurate and timely reachability
information in the neighbor cache.
Retrans Timer Specify the time in milliseconds between retransmissions of
neighbor solicitation messages. This value reduces the
frequency of retries when attempting to discover or confirm
the reachability of neighbors on the network.
• RA, DHCPv4 Server, and DHCPv4 Relay cannot be enabled if there is an alias interface
configured for the main/primary interface.
• A maximum of 10 prefixes can be configured in the RA configurations per interface.
Setting Description
WAN–side Configuration
Interface mode: Orchestrator release 9.5.2 and later supports IPv4 and IPv6 to meet the
increasing demand for IP addresses. This feature also allows you to deploy appliances that
support both IPv4 and IPv6 for a dual stack solution.
NOTE: The WAN interfaces of factory deployed appliances with ECOS version 9.5.2 and later
support both IPv4 and IPv6 addresses for Zero Touch Provisioning (ZTP). Appliances with pre-
vious versions of ECOS only support IPv4.
IMPORTANT: ZTP for IPv6 is not supported for EC-Vs.
Select one of the following options for each WAN interface:
• DHCPv4 + DHCPv6 – This is a dual-stack mode that supports the simultaneous use of
IPv4 and IPv6 addresses. The IPv6 address is configured dynamically by DHCP on the
primary interface and the IPv4 address is configured dynamically by DHCP on the alias
interface. All properties except Label are inherited from the primary interface and cannot
be edited.
• DHCPv4 + SLAAC – This is a dual-stack mode that supports the simultaneous use of IPv4
and IPv6 addresses. The IPv6 address is configured dynamically by SLAAC on the primary
interface and the IPv4 address is configured dynamically by DHCP on the alias interface.
All properties except Label are inherited from the primary interface and cannot be edited.
NOTE: Only one DHCP configuration option is allowed for each physical interface.
Firewall Zone: Zone-based firewall policies are configured globally on the Orchestrator. A
zone is applied to an Interface. By default, traffic is allowed between interfaces labeled with
the same zone. Any traffic between interfaces with different zones is dropped. You can create
exception rules (Security Policies) to allow traffic between interfaces with different zones. The
firewall zones you have already configured will be in the list under FW Zone. Select the Firewall
Zone you want to apply to the WAN you are deploying.
Firewall Mode: Four options are available at each WAN interface:
• Allow All permits unrestricted communication. Use this option with extreme caution
and only if the interface is behind a WAN edge firewall.
• Stateful __*only__* allows communication from the LAN-side to the WAN-side.
Use this if the interface is behind a WAN edge router.
• Stateful with SNAT applies Source NAT to outgoing traffic.
Use this if the interface is directly connected to the Internet and you want to enable local
internet breakout.
• Harden
– For traffic inbound from the WAN, the appliance accepts __*only__* IPSec tunnel
packets that terminate on an EdgeConnect appliance.
– For traffic outbound to the WAN, the appliance __*only__* allows IPSec tunnel pack-
ets and management traffic that terminate on an EdgeConnect appliance.
VLAN Settings: With Orchestrator release 9.5.2 and later, you can assign multiple IP aliases
to the same VLAN interface ID. Prior to Orchestrator release 9.5.2, Orchestrator only allowed
you to assign one unique IP address to a VLAN ID. This new feature also allows you to assign
VLAN IDs to interfaces in a dual stack solution with SLAAC.
Sub-interfaces behave the same as physical interfaces.
NOTE: If you modify the IP address or subnet mask of a sub-interface, all sub-interfaces and
IP aliases with the same ID will be deleted and added back. The label, segment, and zone will
remain unchanged. There will be a brief outage of all IPs while the interfaces are deleted and
added back.
IP aliases and sub-interfaces will appear in all tabs where interfaces are listed or selectable
(for example, the Dynamic table on the Interfaces tab). The first sub-interface will be the main
interface. Additional IP aliases will be assigned with incremented interface numbers. For
example, the main sub-interface will be wan0.120 and additional IP aliases will be assigned
wan0.120:1, wan0.120:2, and so on.
NAT Settings: To change the NAT setting, click the NAT-related link under the Next Hop field
on the WAN side. The NAT Settings dialog box opens.
Select one of the following options:
• For additional bandwidth, you can purchase Plus, and then select it here for this profile.
• If you have purchased a pool of WAN Optimization for your network, you can allocate a
portion of it in the WAN Opt field in a Deployment Profile. You can also direct allocations
to specific types of traffic in the Business Intent Overlays.
• To view how you have distributed Plus and WAN Optimization, navigate to the Configu-
ration > Overlays & Security > Licensing > Licenses tab.
• Select the appropriate licensing you have applied to your EdgeConnect appliance from
the menu. The licenses will only display depending on the licenses you have for that
particular account. You can select the following licensing options:
– Mini
– Base
– Base + Plus
– 50 Mbps
– 200 Mbps
– 500 Mbps
– 1 Gbps
– 2 Gbps
– Unlimited
NOTE: You must have the correct hardware to support the license selected.
BONDING
• For traffic inbound from the WAN, the appliance accepts __*only__* IPSec tunnel packets.
• For traffic outbound to the WAN, the appliance __*only__* allows IPSec tunnel packets
and management traffic.
Bridge Mode
Single WAN-side Router
In this deployment, the appliance is in-line between a single WAN router and a single LAN-side
switch.
Router Mode
There are four options to consider:
1. Single LAN interface & single WAN interface
2. Dual LAN interfaces & dual WAN interfaces
3. Single WAN interface sharing LAN and WAN traffic
4. Dual WAN interfaces sharing LAN and WAN traffic
__*For best performance, visibility, and control, Options #1 and #2 are recommended because
they use separate LAN and WAN interfaces.__* And when using NAT, use Options #1 or #2 to
ensure that addressing works properly.
#1 - Single LAN Interface & Single WAN Interface
1. You can put EdgeConnect __*in-path__*. In this case, if there is a failure, you need other
redundant paths for high availability.
2. You can put EdgeConnect __*out-of-path__*. You can redirect LAN-side traffic and WAN-
side traffic from a router or L3 switch to the corresponding interface using WCCP or PBR
(Policy-Based Routing).
To use this deployment with a single router that has only one interface, you could use multiple
VLANs.
#2 - Dual LAN Interfaces & Dual WAN Interfaces
This deployment redirects traffic from two LAN interfaces to two WAN interfaces on a single
EdgeConnect appliance.
1. You can put EdgeConnect __*in-path__*. In this case, if there is a failure, you need other
redundant paths for high availability.
2. You can put EdgeConnect __*out-of-path__*. You can redirect LAN-side traffic and WAN-
side traffic from a router or L3 switch to the corresponding interface using WCCP or PBR
(Policy-Based Routing).
This deployment redirects traffic from a single router (or L3 switch) to a single subnet on the
EdgeConnect appliance.
This deployment redirects traffic from two routers to two interfaces on a single EdgeConnect
appliance.
This is also known as Dual-Homed Router Mode.
• Do you want your traffic to be in-path or out-of-path? This mode supports both deploy-
ments. In-path deployment offers much simpler configuration.
• Does your router support VRRP, WCCP, or PBR? If so, you might want to consider out-
of-path Router mode deployment. You can set up more complex configurations, which
offer load balancing and high availability.
• Are you planning to use host routes on the server/end station?
• In the rare case when you need to send inbound WAN traffic to a router other than the
WAN next hop router, use LAN-side routes.
How you plan to optimize traffic also affects whether you also need __*inbound redirection
from the WAN router__* (known as WAN-side redirection):
• If you use subnet sharing (which relies on advertising local subnets between EdgeCon-
nect appliances) or route policies (which specify destination IP addresses), you only
need LAN-side redirection.
• If, instead, you rely on TCP-based or IP-based auto-optimization (which relies on initial
handshaking __*outside__* a tunnel), you must also set up inbound and outbound redi-
rection on the WAN router.
• For TCP flows to be optimized, both directions must travel through the same client and
server appliances. If the TCP flows are asymmetric, you need to configure flow redirec-
tion among local appliances.
A tunnel must exist before auto-optimization can proceed. There are three options for tunnel
creation:
• If you enable auto-tunnel, the initial TCP-based or IP-based handshaking creates the
tunnel. This means that the appropriate LAN-side and WAN-side redirection must be in
place.
• You can allow the Initial Configuration Wizard to create the tunnel to the remote appliance.
• You can create a tunnel manually on the Configuration > Networking > Tunnels > Tun-
nels page.
Server Mode
This mode uses the mgmt0 interface for management and datapath traffic.
• You can create additional data-plane Layer 3 interfaces to use as tunnel endpoints.
• To add a new logical interface, click +IP.
Deployment - EdgeHA
EdgeHA mode is a high availability cluster configuration that provides appliance redundancy
by pairing two EdgeConnect devices together.
When a deployment profile configures two EdgeConnect appliances in EdgeHA mode, the re-
silient cluster acts as a single logical system. It extends the robust SD-WAN multipathing ca-
pabilities such as Business Intent Overlays seamlessly across the two devices as if they were
one entity.
With EdgeHA mode, a WAN uplink is physically plugged into a single one of the EdgeConnect
appliances but is available to both in the cluster. For WAN connections that perform NAT (for
example, a consumer-grade Broadband Internet connection), it means that only a single Public
IP needs to be provisioned in order for both EdgeConnect devices in the EdgeHA cluster to be
able to build Business Intent Overlays using that transport resource.
NOTE: EdgeHA does not support Active/Active deployments (that is, equal-cost multi-path
[ECMP] routing). Active/Passive deployments are supported; the primary EdgeHA appliance
carries all traffic to and from the LAN side of the EdgeHA cluster. You can configure Active/-
Standby (Backup) by using Virtual Router Redundancy Protocol (VRRP), Border Gateway Pro-
tocol (BGP), Open Shortest Path First (OSPF) protocol, or Bidirectional Forwarding Detection
(BFD) protocol.
VRRP Configuration
Typically, in a branch site deployment, you will choose to configure the cluster with a VRRP
protocol and assign a VIP (virtual IP) address to the cluster.
• Set the VRRP priority of the preferred LAN-side Primary EdgeConnect to 128.
• Set the other, Secondary appliance’s VRRP priority to 127.
LAN-side Monitoring
The IP SLA feature should be configured to monitor the LAN-side VRRP state in order to auto-
matically disable subnet sharing from that appliance in the case of a LAN link failure.
For more information, refer to the IP SLA configuration guide.
Firewall Zones
Configuration > Overlays & Security > Security > Firewall Zones
Zone-based firewalls are created on the Orchestrator.
• A zone is applied to an Interface.
• By default, traffic is allowed between interfaces labeled with the same zone.
• Any traffic between interfaces with different zones is dropped.
• Users can create exception rules (Security Policies) to allow or deny traffic between in-
terfaces within the same or different zones.
NOTE: “Default” will always be the initial default zone. You cannot have another zone named
“Default”.
NOTE: The name of your firewall cannot exceed 16 characters and cannot contain any special
characters. It can contain alphanumeric characters and underscores only.
Auto rate limit is a DoS threshold setting that uses baseline learning to compute the minimum
DoS threshold. The maximum DoS threshold is configured above the baseline minimum. Auto
rate limit helps assess network zone capacities and platform performance levels; normal ver-
sus oversubscribed. It allows significant burst but limits a zone to a percentage of appliance
capacity. The maximum value is not sensitive to zone trends, and flows that exceed the maxi-
mum value are “tail dropped” even if the zone or appliance has flow capacity.
Smart Burst
Smart burst is a DoS threshold setting that uses baseline learning to compute both minimum
and maximum DoS thresholds and allocates extra flow capacity. It uses a triple token bucket
zone-based policer schema for burst management. Smart burst does the following:
• Supports two levels of bursts to mitigate tail drops and manages spare capacity of appli-
ances to support bursts.
– The spare capacity is distributed among all zones and is called committed burst.
Committed burst is the first level of burst capacity.
– On a per second basis, unused committed burst in zones is made available as a
second level of burst capacity that is referred to as excess burst. Unused excess
burst capacity goes back to the respective committed burst periodically.
1. Click the edit icon next to the appliance you want to enable baseline learning for.
The Firewall Protection Profiles dialog box opens.
2. Select the Baseline Learning check box.
3. To customize the baseline learning settings, click Baseline Settings.
The Baseline Settings dialog box opens.
4. Enter the following information based on your network or click Cancel to use the default
settings.
Field Description
Data aggregation The technique used for data aggregation. The default is percentile
method and there are currently no other options.
Data aggregation Indicates what percentage of the sample data is used to determine
limit baseline values. The default setting is 95%, which means the top 5%
of the sample is discarded and the other 95% is considered when
computing the baselines. You can enter a value between 75-100%.
Computation The time that passes before the system computes new baselines.
interval The default is 8 hours. For example, when using the default, the
baselines are computed every 8 hours using the latest sample data
collected during the Model training interval. This can be configured
in 4-hour units (e.g., 4, 8, 12, and so on) up to 240 hours.
Field Description
Model training During this period, data is collected for various metrics every five
interval minutes and is aggregated into a data file. This data is used to
compute the baselines. The default is 14 days, the minimum is 7
days, and the maximum is 56 days.
NOTE: This period should include a diverse set of data that covers
various types of legitimate traffic and captures the characteristics
that distinguish normal traffic from malicious traffic during an attack.
Baseline upper limit The upper limit for the minimum baseline. An alarm is raised when
this value is reached. This setting is useful if Auto rate limit is
configured without Smart burst. The setting is a percentage of the
maximum baseline value, which is set manually. The default is 90%.
You can enter a value between 50-100%.
TCP inactivity Inactivity timeout used for TCP flows created using burst support
timeout levels. Inactive flow gets deleted after this timeout. The default is
300 seconds. You can enter a value between 30-1800 seconds.
Headroom for The percentage of headroom that is added to the baseline. The
baseline plus default is 20%. You can enter a value between 5-100%.
Per-source limit for The committed burst for a zone is available to all sources in the
committed burst zone. This determines the percentage of committed burst in a zone
that one source can use. The default is 50%. You can enter a value
between 1-50%.
Reserve flow Spare flow capacity is distributed among all zones by Smart burst
capacity using different methods (Proportional or Equal). The default
distribution method is Proportional.
Excess burst credit On a per second basis, the zone is supposed to use a portion of
interval committed burst capacity. Unused committed burst capacity of
zones is made available as excess burst capacity every second. After
this interval of time, unused excess burst capacity goes back to the
respective committed burst. The default is 30 seconds. Enter a value
between 30-100 seconds.
Minimum reserve The minimum amount of reserve flow capacity that should be
capacity limit available before Smart burst redistributes new reserve capacity after
a baseline computation interval. Smart burst continues with
previously distributed capacities if the minimum reserve capacity
limit is not available. The default is 20%. You can enter a value
between 10-50%.
5. Click OK.
2. Navigate to Configuration > Overlays & Security > Security > Firewall Protection Pro-
files.
3. Click the edit icon next to the appliance you want to configure a profile for.
The Firewall Protection Profiles - <Appliance Name> dialog box opens.
Field Description
Allowlist Enter an existing Address Group. Any IP address contained within the
Address Group will be exempt from DoS threshold analysis. The Allowlist
does not exempt flows from the options shown in the Security Settings
section.
Field Description
Blocklist Enter an existing Address Group to explicitly block any IP address contained
within the configured Address Group.
9. (Optional) Click Show advanced settings and set the following fields:
Field Description
Rapid Set a threshold value (in seconds) to enforce the tearing down of TCP
aging connections when the period of inactivity matches the configured value (for
example, 30s).
Block Enforce dynamic blocking of flows originating from a source for a specified
duration duration (for example, 300s).
Embryonic Set this value so that the firewall can tear down half-open TCP connections
timeout when the timeout value is reached (for example, 30s). While TCP connection
goes through the three-way handshake (SYN, ACK, SYN-ACK), an embryonic
connection is a half-open connection that produces (for example) a SYN
without the other two parts of the handshake. This is a popular form of
denial of service (DoS) attack.
Share Select this check box to enable unused committed burst to be shared with
committed other zones. This check box is enabled by default. For critical zones, you can
burst disable this option, which retains the committed burst capacity for the zone
itself.
1. Click the edit icon next to the appliance you want to configure.
The Firewall Protection Profiles - <Appliance Name> dialog box opens.
2. Click the edit icon next to the profile name whose threshold you want to edit.
The Firewall Protection Profile dialog box opens.
3. Either select a preset threshold from the DoS Thresholds drop-down list, or click Add
Custom Threshold.
The DoS Threshold dialog box opens.
4. Set the following parameters:
Field Description
Zone level: Flows originating from multiple endpoints that are part of a
single firewall zone.
Source level: All flows originating from a single endpoint or source device.
Metric DoS thresholds can be configured with any or all of the three metrics
available in a firewall protection profile:
Flows per second: Rate of flow (fps). A single flow is a unidirectional set of
packets containing common attributes (source and destination IP, ports,
protocols).
Concurrent Flows: Number of flows that are active at a given point in time.
Field Description
Max Label Select the method used to determine the max value:
5. Click OK.
5. Click Save.
1. In the Firewall Protection Profiles table, click the value in the Thresholds Count column
that corresponds to the appliance/segment/zone entity you want to view.
The DoS Thresholds - <Appliance Name> dialog box opens.
2. View the following parameters:
Field Description
Classification Zone level flows originate from multiple endpoints that are part of a single
firewall zone.
Field Description
Metric Flows per second is the rate of flow (fps). A single flow is a unidirectional set
of packets containing common attributes (source and destination IP, ports,
protocols).
Concurrent flows are the Number of active flows at a given point in time.
NOTE: When a flow breaches both min and max threshold values, it appears
in the Max exceed sources column.
Max Time since the threshold breach occurred. This data can be extracted and
exceed analyzed in firewall logs.
time
Trends Click the value to open the Protection Profile Trends tab. The selected
threshold filters are applied showing real-time trends data. See Protection
Profile Trends.
You can also view the number of min and max threshold breaches on the main table on the
Firewall Protection Profiles tab, in the Min Thresholds/Max Thresholds columns.
Internet Traffic
Configuration > Overlays & Security > Internet Traffic Definition
Internet traffic is any traffic that __*does NOT match__* the internal subnets listed in this dialog
box.
1. Inactive appliances: When appliances are inactive, they exist in the Orchestrator, but
do not have tunnels configured to any active appliances.
2. Temporary unreachability: Temporary unreachability issues occur in cases where an
EdgeConnect appliance reboots or if there is a link or communication failure. In this
case, Orchestrator will not activate the new key material until all active appliances are
reachable and have received the new key material or if the maximum activation wait
time has been exceeded. If the appliance is unreachable for a period longer than the key
rotation interval, it will be treated as an inactive appliance.
Re-authorization: Inactive appliances that become active at a later point in time will be au-
thorized to receive the current key material. Only then will they be able to download configu-
rations and build tunnels.
Field Description
Enable Key Rotation Select this check box to enable key rotation.
Persist Key Material If enabled, key material is stored on each appliance, ensuring
data plane tunnels are built quickly after an appliance reboot (no
dependency on Orchestrator). If disabled, new key material from
Orchestrator is required after any reboot (Orchestrator
reachability is critical).
Field Description
Max Activation Wait Maximum time (in hours) Orchestrator must wait before
activating the new key material. This wait time applies only when
unreachable appliances exist in the network and at least one
tunnel is UP from a reachable appliance to an unreachable
appliance. This gives you time to fix connectivity issues. After the
wait time expires, Orchestrator activates the new key material on
all reachable appliances. Generally, it is recommended to set this
wait time to half of the rotation period.
Rotation Period Click the edit icon to set the rotation and the time you want the
key material rotation to begin. Click Force Rotate to immediately
start a new key material rotation.
Key Material Lifetime Amount of time a key material lasts.
Field Description
The following security settings enable appliances to verify certificates. EdgeConnect appli-
ances are pre-loaded with the Mozilla root store, which contains the root certificates of public
certificate authorities (CAs). Appliances use this root store for cryptographic verification when
opening Transport Layer Security (TLS) connections to Orchestrator and the Cloud Portal.
The top portion indicates verification progress and results. The table explains any unsuccess-
ful connections.
The Advanced Security Settings dialog box also displays the following security settings:
• Enforce CSRF Token Check
Enables Cross-Site Request Forgery (CSRF) token checking. Use this setting while using
Orchestrator REST APIs and to avoid CSRF vulnerabilities. Before you enable this setting,
be sure that the X-XSRF-TOKEN header in your script is set to the orchCsrfToken value
returned by Orchestrator. This ensures that requests are legitimate and do not come
from unauthorized sources, which helps prevent CSRF attacks and enhances security.
NOTE: It is highly recommended that you enable this setting. Any API scripts must be
verified to ensure that X-XSRF-TOKEN is set appropriately.
• Verify System Files Integrity
Enables verification of image signatures of binaries during the bootup process for ap-
pliances that are not FIPS certified. Appliances will verify the integrity of library and
executable files. FIPS-certified appliances will ignore this setting and will always verify
signatures of binaries at bootup. Be aware that enabling this setting increases bootup
time by five or more minutes.
– If enabled, appliance software checks for digital signature match. If the signature is
valid, the installation or upgrade process continues.
– If verification fails, the upgrade process fails.
– Open Shell Access – Allows users to fully use the appliance Linux shell. For new
installations, this setting is no longer available.
– Secure Shell Access – Restricts Linux shell use by requiring token access from Sup-
port. This is the default setting for new installations.
– Disabled Shell Access – Completely locks down access to the appliance Linux shell.
IMPORTANT: Once shell access is disabled, it cannot be reverted to secure shell
access. You must redeploy to a new or remanufactured appliance.
• IDS designates traffic for inspection using matching rules enabled in the zone-based fire-
wall.
• IPS protects traffic by matching a signature and then performing a configured action
(Drop, Inspect, or Allow).
Use the Intrusion Detection/Prevention tab to view IDS/IPS status or state, or to modify the
IDS/IPS configuration for appliances selected in the appliance tree.
The Auto updates ON and OFF buttons enable you to control whether signatures should be
automatically updated. By setting this to OFF, you can make informed decisions before pro-
ceeding with signature updates. To make this evaluation, use the Signature History subtab to
examine the differences between the signature rules in the latest active signature version on
Cloud Portal and the production rules in your current signature version in Orchestrator.
Field Description
– ECOS 9.1.x.x or later for all EdgeConnect appliances except EC-XS (part numbers
200889 and 200900 only) and EC-US
– ECOS 9.1.x.x or later for EC-V deployments (minimum of 4 cores and 16 GB of RAM
required)
For IDS/IPS:
– ECOS 9.2.x.x or later for all EdgeConnect appliances except EC-XS (part numbers
200889 and 200900 only) and EC-US
– ECOS 9.2.x.x or later for EC-V deployments (minimum of 4 cores and 16 GB of RAM
required)
• IDS/IPS can be enabled only on appliances running ECOS 9.1.0.0 or later. Appliances run-
ning an earlier version of ECOS will not be shown on the Intrusion Detection/Prevention
tab.
• IDS/IPS is a licensed feature and can be enabled only on appliances that have been as-
signed the Advanced Security license. Refer to the help information for the Licenses tab
(Configuration > Overlays & Security > Licensing > Licenses).
NOTE: IDS/IPS alarms are logged in standard syslog format. You can configure a logging facility
for IDS/IPS and remote log receiver to send logs to a third party for additional review and
analytics. See Advanced Reporting and Analytics below.
3. To apply a different signature profile, select the Profile check box, and then select the
appropriate signature family from the first drop-down list. The second drop-down list in-
cludes the Orchestrator-provided default profile that corresponds to the signature family
you selected (Default for 4.x or Default_S5 for 5.x) and any other signature profiles you
have created. Select the signature profile you want to use. For more information about
signature profiles, see Manage Signature Profiles below.
4. The Modification column displays the proposed changes, if any, for the appliances. To
apply your changes, click Save. Or, to close the dialog box without making any changes,
click Cancel.
These default profiles include default settings for the signature rules. Default profiles are auto-
matically used across all appliances. You can create additional signature profiles and override
default rule settings by choosing different actions as needed. To open the Signature Profiles
tab, click Signature Profiles. For information about creating signature profiles and modifying
their rules, refer to the help information for the Signature Profiles tab.
• A signature version listed in the top table and the preceding listed version.
• The current version (listed in the top table) and the active signature version on cloud
portal (listed in the bottom table). To view these differences, Auto updates must be set
to OFF on the Intrusion Detection/Prevention tab.
You can select a different signature family from the Signature Family drop-down list.
The Level column indicates the rules package applied to the IDS/IPS subsystem with vary-
ing levels of rules that control the strictness of inspection on the device. This setting does
not indicate a restriction level on IPS usage. Rather, it specifies the intensity of IDS/IPS in-
spection (from lenient to strict) based on the selected rules package. Only the Strict rule
package is currently supported. The Updated Date column indicates when the signature
version was last updated.
The bottom table (Active signature on cloud portal) shows the active signature version
on the Cloud Portal.
2. To view the differences, click the appropriate chart icon in the Diff column.
Use the tabs on this dialog box to view lists of new, modified, or deleted signatures in
the signature version compared to the previous one.
With the addition of IDS/IPS, firewall actions have the following meanings:
NOTE: No traffic will be inspected until rules with the inspect action are specified in the security
policy.
For more information, see the following tabs in Orchestrator:
• Templates (Security Policies): Configuration > Templates & Policies > Templates
• Routing Segmentation: Configuration > Networking > Routing > Routing Segmentation
(VRF)
Signature Profiles
Signature profiles enable you to configure rules that are downloaded from the Cloud Portal.
Orchestrator provides the following default signature profiles:
These default profiles include default settings for the signature rules. Default profiles are auto-
matically used across all appliances. You can create additional signature profiles and override
default rule settings by choosing different actions as needed.
By default, all rules included in the signatures list are enabled on all appliances where IPS is
enabled. The default action is to drop traffic when a rule is triggered. However, for certain
traffic or in some other cases, you might want to specify different actions for IPS to take.
1. To open the Signature Profiles tab, click Signature Profiles on the Intrusion Detec-
tion/Prevention tab (Configuration > Overlays & Security > Security > IDS/IPS).
2. Select the appropriate signature family from the Signature Family drop-down list.
NOTE: You can apply profiles for the 5.x signature family only to appliances with IPS
engine version 6.x or later.
3. Initially, the Profile field indicates that rules for the default signature profile (Default for
the 4.x signature family or Default_S5 for the 5.x signature family) are displayed on this
tab. To change the displayed signature profile, select the appropriate profile from the
Profile drop-down list.
To create signature profiles, see Create a Signature Profile below.
4. Use the Filter Rules field above the table to filter the list of rules. You can also use the
filters to the right of the field to view rules by affected products, rule category, severity,
and/or action.
5. To set the response for a specific rule, select one of the following actions from the drop-
down list in the Action column. For multiple rules, select the appropriate rule rows in
the table, and then select an action from the Bulk Edit Filtered Rules drop-down list.
• Drop: Drop the traffic when a matching signature condition exists for the source,
destination, or both.
• Inspect: Continue the traffic flow to the destination after inspecting the traffic and
raising an event for matching signature. This action detects the anomaly.
• Allow: Excludes the rule from participating in IDS/IPS, rendering it no longer part of
IDS/IPS processing.
NOTE: You can change signature rules for any custom signature profile, but you can-
not change the Default signature profile. This ensures that you always have the original
signature rules as provided by Orchestrator.
You can apply profiles to your appliances by clicking the Apply Profile link. For details,
refer to the help information for the Intrusion Detection/Prevention tab.
1. On the Signature Profiles tab, select the appropriate signature family from the Signature
Family drop-down list
2. Click the edit icon associated with the Profile field.
The Signature Profiles dialog box opens.
3. Click + Add.
The Add Signature dialog box opens.
4. Verify that the appropriate signature family is indicated.
5. In the Profile Name field, enter a signature profile name, and then click Ok.
The new signature profile appears on the Signature Profiles dialog box.
NOTE: If your newly created signature profile is based on signature family 5.x (or when
previously existing signature profiles based on signature family 4.x are migrated dur-
ing ECOS upgrade), Orchestrator appends the profile name you provided with *_S5. For
example, if the profile name is BankCo, Orchestrator changes it to BankCo_S5*.
6. Click Save.
Roles
Configuration > Overlays and Security > Security > Roles
This dialog box allows you to define and map roles that are used throughout the EdgeConnect
SD-WAN Fabric. For example, you can map a role to a Group Policy Identifier (GPID) from an
HPE Aruba Networking CX Switch to facilitate identity (role) awareness between SD-WAN Or-
chestrator and HPE Aruba Networking CX Switches. After you map a role to a GPID, you can
specify the role in match criteria when creating Access Lists and policies in SD-WAN Orches-
trator.
You can also use this tab to import roles and GPIDs from a CSV file.
Prerequisites
• This feature is only available for Orchestrator version 9.4.1 and ECOS version 9.4.1.0 and
later.
• GPID values and roles must match the GPID values configured on the HPE Aruba Net-
working CX Switch.
For more information on configuring VXLAN and a VTEP source loopback interface on the Edge-
Connect appliance, see VXLAN Tab or VXLAN Template.
Add Roles
Add all the roles that are required for each VXLAN segment. If the VXLAN segment encounters
a role that is not defined in Orchestrator, that role is labelled “unknown”.
To add roles:
Import CSV
To import roles and GPIDs from a CSV file:
Color Description
Green Indicates a new GPID and role mapping. This role and GPID will
be added to the table.
Color Description
Yellow Indicates a duplicate GPID. The existing role for the GPID will be
replaced with the role in the file you are importing.
Red Indicates a duplicate role. The duplicate role will not be added
to the table even if the GPID does not match.
If you want your Orchestrator and appliances to establish connectivity with any of the following
services, you must add the certificates for these services to the Custom CA Certificate Trust
Store:
Follow these steps to add well-known, globally trusted certificates from the default trust store
to the Custom CA Certificate Trust Store:
1. Click Test Connectivity to Portal to validate that appliances can successfully connect to
Orchestrator and Cloud Portal using the custom CA.
2. Click the Use Custom Certificate Trust Store check box.
3. Click Apply Changes.
Follow these steps to add a CA certificate to the custom certificate trust store:
NOTICE: After adding root CA certificates to the Custom Trust Store, Orchestrator must be
restarted.
The EdgeConnect platform consists of Cloud Portal, Orchestrator, and EdgeConnect gateways
running EdgeConnect OS (ECOS). Historically, EdgeConnect supported Certificates for a few
limited applications such as verifying identity between the triad of Cloud Portal, Orchestrator,
and associated EdgeConnect Gateways. Certificates could also be installed so the web server
for the Orchestrator UI and ECOS UI can be trusted by browsers with their built-in trust store.
Release 9.4 introduces the use of end entity certificates for IPSec tunnel peer authentication.
The following are use cases for end entity certificates in 9.4:
• Configure an EST (Enrollment over Secure Transport) server profile to enroll certificates
for use with your EdgeConnect appliances.
• Create orchestrated appliance end entity profiles that allow for automated enrollment
of certificates using an EST server.
• Manually create a certificate signing request (CSR) and add an end entity certificate for
an appliance or Orchestrator, and manually create a labeled profile that enables Edge-
Connects to generate CSRs.
• Click Appliance to view end entity certificates for your appliances.
• Click Orchestrator to view end entity certificates for Orchestrator.
The information in the following table is displayed for each end entity certificate on this tab.
Column Description
Column Description
Method 2: You can use this method to enroll certificates for use with both Orchestrator and
EdgeConnect appliances. It is a manual method, and you must repeat the process for each
EdgeConnect appliance.
• Revocation Status: Online Certificate Status Protocol (OCSP) is run by Orchestrator and
EdgeConnect to verify that the intermediate CA certificates and end entity certificate are
not revoked using the OCSP URLs present in each of these certificates. OCSP exception
checking includes the following:
– If communication cannot be established with the OCSP server, then the revocation
check is ignored.
– Nonce check:
* If the OCSP server does not return a nonce, then the nonce test is ignored, and
the revocation check continues.
* If the OCSP server returns a nonce that does not match the nonce in the OCSP
request, then the revocation check fails, and the end entity certificate is rejected.
* If the OCSP server returns a nonce that matches the nonce in the OCSP request,
then the revocation check continues.
– If the OCSP response does not contain a status for the certificate that was requested,
then the revocation check fails, and the end entity certificate is rejected.
– If the OCSP response is not signed by the CA that issued the certificate or signed
by an OCSP responder delegated by the CA (the delegated responder should have
a valid certificate signed by the CA containing the OCSP signing purpose), then the
revocation check fails, and the end entity certificate is rejected.
– This update: If the OCSP response for “this update” is in the future, then the revo-
cation check fails, and the end entity certificate is rejected.
– Next update: If the OCSP response for “next update” is in the past, then the revoca-
tion check fails, and the end entity certificate is rejected.
After completion of all the above checks, and if the OCSP response was valid, revoca-
tion status itself is determined and is assigned one of these values: good, revoked, or
unknown. The certificate is accepted for “good” or “unknown” statuses. If the revocation
status is “revoked” the certificate is rejected.
• Expiry Status: Each certificate in the chain is verified as not expired.
• Issuer Sequence Check: The signed end entity certificate that is being uploaded must
contain the entire certificate chain and it must be contained in a single file. The system
verifies that the end entity certificate chain comes first, followed by the intermediate CA
certificate, and finally the root CA certificate.
• Digital Signature Validation: The digital signature for each certificate in the chain is vali-
dated.
• Check for CA Certificates in Custom CA Certificate Trust Store:
– If the signed end entity certificate is for use with Orchestrator, Orchestrator checks
that the root CA certificate in the end entity certificate chain is present in the Or-
chestrator Custom CA Certificate Trust Store.
– For manually uploaded certificates, if the signed end entity certificate is for use with
an EdgeConnect appliance, that specific EdgeConnect checks that the intermedi-
ate CA and root CA certificates in the end entity certificate chain are present in the
EdgeConnect Custom CA Certificate Trust Store. For orchestrated certificates, the
EdgeConnect only checks that the root CA certificate is present in the EdgeConnect
Custom CA Certificate Trust Store.
• Common Name Comparison: The common name in the CSR is compared to and must
match the common name in the signed certificate.
• Subject Alternative Name Comparison: Checks that the subject alternative names in the
CSR are present in the signed certificate.
• Key Correspondence: At the time that the CSR is generated it contains only the public
key; the private key is stored only on this specific EdgeConnect appliance. When the
signed certificate is uploaded, it contains the public key from the CSR. The EdgeConnect
appliance validates that the public key in the certificate mathematically corresponds to
the private key it has stored (the EdgeConnect does not store the public key).
• Starting with the release that includes end entity certificate orchestration, if you se-
lect TLS Server or TLS Client in the Purpose field when creating an appliance end en-
tity profile, an additional check is performed. The check validates that the Extended
Key Usage field on the enrolled certificate contains the text TLS WWW [Server|Client]
Authentication.
NOTE: If manual upload of an end entity certificate fails, navigate to Orchestrator > Orches-
trator Server > Tools > Audit Logs and enter “end entity” in the Search field. In the search
results, look for entries with “end entity upload action” in the Action field and find the recent
failed upload, which will show “Failed” in the Success column. Hover over the Results column
for additional information.
• You must add the default root CA certificates from the default trust store to the Custom
CA Certificate Trust Store (one-time action). This is primarily required to ensure that the
root CA certificate for HPE Aruba Networking Cloud Portal is in the Custom CA Certificate
Trust Store.
• Upload the root CA certificate for the CA that will sign the CSR for the Orchestrator HTTPS
server certificate.
• Upload the root CA certificate for the CA that signed the end entity certificate for the
syslog server (this is the syslog server to which Orchestrator sends its logs).
• Upload the root CA certificate for the CA that signed the end entity certificate for the EST
server.
• If you are using the orchestrated EST-based method, upload the root CA certificate for
any CA that will be signing all end entity certificates.
NOTE: The certificates for the CA must be in place before you create an appliance end
entity profile otherwise validation of the certificate orchestration will fail.
• If you are using the manual method, upload both the root CA and intermediate CA cer-
tificates for the CA that will sign the CSR.
NOTE: The certificates for the CA must be in place when you upload the signed certificate
chain otherwise validation of the certificate will fail.
To upload the necessary certificates, navigate to Configuration > Overlays & Security > Se-
curity > Custom CA Certificate Trust Store. For instructions on how to enable the trust store
and upload a certificate, see Custom CA Certificate Trust Store.
EST Servers
You can configure profiles for EST servers that are used to enroll certificates for use with Edge-
Connect appliances. Using an EST server with appliance end entity profiles provides an auto-
mated process for using globally orchestrated certificates for authentication. From this dialog
box you can view the EST server profiles that are configured, delete EST server profiles, and
add EST server profiles.
NOTE: An EST server must be reachable out-of-band without dependence on IPSec tunnels.
EST management plane is configured in the Management Services template (Configuration >
Templates & Policies > Templates) using the management service named “Other VRF mgmt
Apps”.
1. Navigate to Configuration > Overlays & Security > Security > End Entity Certificates.
2. Click EST Servers.
The EST Servers dialog box opens.
Field Description
Example:
https://est-service999.com/.well-known/est/rsa2048/cacerts
Where /rsa2048 is the arbitrary label.
Arbitrary enrollment When the system attempts to enroll a certificate, this label is
added to the URL of the EST server. This label is used for
simpleenroll, per RFC 7030. Requirements are EST server
dependent. The default is blank.
Example: https://est-service999.com/.well-
known/est/rsa2048/simpleenroll
Where /rsa2048 is the arbitrary label.
Arbitrary re-enrollment When the system attempts to enroll a certificate, this label is
added to the URL of the EST server. This label is used for
simplereenroll, per RFC 7030. Requirements are EST server
dependent. The default is blank.
Example: https://est-service999.com/.well-
known/est/rsa2048/simplereenroll
Where /rsa2048 is the arbitrary label.
Field Description
Retry interval Enter a numeric value (in seconds). During initial enrollment
or re-enrollment of a certificate, this is the amount of time
the system waits before it contacts the EST server again. It
keeps attempting at this interval until the enrollment or
re-enrollment is successful.
5. Click Save.
6. Click Save and Apply Changes.
7. Click Close.
Field Description
TLS Server – When selected, certificates that are enrolled using this
profile are only used for HTTPS server authentication, for example
EdgeConnect web UI. Profiles with this purpose appear on the HTTPS
Certificate template and can be selected as the source for the end
entity certificate for authentication.
TLS Client – When selected, certificates that are enrolled using this
profile are only used for Syslog client authentication (EdgeConnect as
client). Profiles with this purpose appear on the Logging template and
can be selected as the source for the end entity certificate for
authentication in the remote log receiver configuration.
Field Description
EST Server Select an EST server profile. The EST server profile must already be
configured. For more information on EST server profile configuration,
see Add an EST Server Profile.
You can select more than one EST server up to a maximum of four, by
clicking +EST. If you have more than one EST server selected, the
system attempts certificate enrollment using the EST servers in the
order they are listed.
Certificate These fields vary based on the Purpose you select.
Information
Common Name – Applies to profiles that have SD-WAN or General
selected for Purpose. This information is auto generated using the
appliance host name, such as “mysystem-ecva”.When a certificate is
enrolled using this profile, this value is used as the Common Name.
Example of how this appears on a certificate:
CN=mysystem-ecva
When a certificate is enrolled using this profile, the hostname and the
user-entered FQDN are included in the SAN (Subject Alternative Name)
field for email.
Example of how this appears on a certificate in the SAN field:
email: [email protected]
Host Name - Applies to profiles that have TLS Server or TLS Client
selected for Purpose. The prefix is auto generated and consists of the
appliance host name, such as “mysystem-ecva”. Enter a domain name
in the field, such as “hpe.com”.
When a certificate is enrolled using this profile, the host name and the
user-entered domain name are included in the SAN field for DNS.
Example of how this appears on a certificate in the SAN field:
DNS: [email protected]
SAN - Domain Name – Applies to profiles that have TLS Server or TLS
Client selected for Purpose. This information is auto generated based
on the domain name you entered in the Host Name field.
Field Description
Additional These fields only appear if you have selected General for the Purpose.
Information
(Optional) Domain Component – The prefix is auto generated and consists of the
appliance host name, such as “mysystem-ecva”. Enter a system domain
name in the field, such as “arubanetworks.com”.
When a certificate is enrolled using this profile, the host name and the
user-entered domain name are included in the SAN field for DNS.
Example of how this appears on a certificate in the SAN field:
DNS: [email protected]
Add Serial Number to Subject – When this check box is selected and
a certificate is enrolled using this profile, the serial number for the
appliance, as shown on the System Information tab, is included in the
SN (Subject Name) field for serial number.
Example of how this appears on a certificate in the SN field:
serialNumber=XXXXXXXXXXXX
5. Click Save.
6. Click Close.
After clicking Save, profile orchestration and certificate enrollment begins. During this time
Orchestrator sends the profile to all EdgeConnect appliances, and then each appliance con-
tacts the EST server to get a certificate and have it validated. When validation is successfully
completed for a certificate, you can open the End Entity Certificates dialog box for an appliance
and a View Certificate link appears in the CSR / Certificate column for the certificate.
Field Description
Field Description
Subject Alternative Name Select one of the following options from the drop-down
(SAN) menu and enter the required information.
‘AF’, ’AL’, ’DZ’, ’AS’, ’AD’, ’AO’, ’AI’, ’AQ’, ’AG’, ’AR’, ’AM’, ’AW’, ’AU’, ’AT’, ’AZ’, ’BS’, ’BH’, ’BD’, ’BB’,
’BY’, ’BE’, ’BZ’, ’BJ’, ’BM’, ’BT’, ’BO’, ’BA’, ’BW’, ’BV’, ’BR’, ’IO’, ’BN’, ’BG’, ’BF’, ’BI’, ’KH’, ’CM’, ’CA’,
’CV’, ’KY’, ’CF’, ’TD’, ’CL’, ’CN’, ’CX’, ’CC’, ’CO’, ’KM’, ’CG’, ’CD’, ’CK’, ’CR’, ’CI’, ’HR’, ’CU’, ’CY’, ’CZ’,
’DK’, ’DJ’, ’DM’, ’DO’, ’EC’, ’EG’, ’SV’, ’GQ’, ’ER’, ’EE’, ’ET’, ’FK’, ’FO’, ’FJ’, ’FI’, ’FR’, ’GF’, ’PF’, ’TF’, ’GA’,
’GM’, ’GE’, ’DE’, ’GH’, ’GI’, ’GR’, ’GL’, ’GD’, ’GP’, ’GU’, ’GT’, ’GN’, ’GW’, ’GY’, ’HT’, ’HM’, ’VA’, ’HN’,
’HK’, ’HU’, ’IS’, ’IN’, ’ID’, ’IR’, ’IQ’, ’IE’, ’IL’, ’IT’, ’JM’, ’JP’, ’JO’, ’KZ’, ’KE’, ’KI’, ’KP’, ’KR’, ’KW’, ’KG’, ’LA’,
’LV’, ’LB’, ’LS’, ’LR’, ’LY’, ’LI’, ’LT’, ’LU’, ’MO’, ’MK’, ’MG’, ’MW’, ’MY’, ’MV’, ’ML’, ’MT’, ’MH’, ’MQ’,
’MR’, ’MU’, ’YT’, ’MX’, ’FM’, ’MD’, ’MC’, ’MN’, ’MS’, ’MA’, ’MZ’, ’MM’, ’NA’, ’NR’, ’NP’, ’NL’, ’AN’,
’NC’, ’NZ’, ’NI’, ’NE’, ’NG’, ’NU’, ’NF’, ’MP’, ’NO’, ’OM’, ’PK’, ’PW’, ’PS’, ’PA’, ’PG’, ’PY’, ’PE’, ’PH’, ’PN’,
’PL’, ’PT’, ’PR’, ’QA’, ’RE’, ’RO’, ’RU’, ’RW’, ’SH’, ’KN’, ’LC’, ’PM’, ’VC’, ’WS’, ’SM’, ’ST’, ’SA’, ’SN’, ’SC’,
’SL’, ’SG’, ’SK’, ’SI’, ’SB’, ’SO’, ’ZA’, ’GS’, ’ES’, ’LK’, ’SD’, ’SR’, ’SJ’, ’SZ’, ’SE’, ’CH’, ’SY’, ’TW’, ’TJ’, ’TZ’,
’TH’, ’TL’, ’TG’, ’TK’, ’TO’, ’TT’, ’TN’, ’TR’, ’TM’, ’TC’, ’TV’, ’UG’, ’UA’, ’AE’, ’GB’, ’US’, ’UM’, ’UY’, ’UZ’,
’VU’, ’VE’, ’VN’, ’VG’, ’VI’, ’WF’, ’EH’, ’YE’, ’ZM’, ’ZW’
The following is an example completed CSR with label “Orchestrator_HTTPS”.
5. Click Save.
The certificate appears in the list of certificates on the End Entity dialog box.
1. Navigate to Configuration > Overlays & Security > Security > End Entity Certificates.
2. Click the edit icon next to the appliance or Orchestrator instance for which you created
the CSR.
The End Entity Certificates dialog box appears.
3. In the End Entity Certificates Dialog box find the certificate you created, and in the CSR /
Certificate column click View CSR.
The View CSR dialog box opens.
4. Click Select Certificate File, and then select the signed certificate chain.
The file name of the end entity certificate appears in gray beneath the Select Certificate
File button.
5. Click Upload.
The system performs validation checks on the end entity certificate. If the certificate
passes the validation checks and upload is successful, the file name turns green.
6. Click Close.
After the certificate is successfully uploaded, on the End Entity Certificates dialog box the
Issuer column contains the common name, the Expiration date column shows when the
certificate expires, and the link in the CSR / Certificate column changes from View CSR
to View Certificate. Click View Certificate to view the certificate.
• HTTP server
– To use a manually added end entity certificate for the Orchestrator HTTPS certificate,
see Orchestrator HTTPS Certificate. The Orchestrator HTTPS certificate cannot be
added using EST.
– To use an orchestrated appliance end entity profile for the EdgeConnect HTTPS Cer-
tificate, see HTTPS Certificate Template.
– To use a manually added end entity certificate for the EdgeConnect HTTPS Certifi-
cate, see HTTPS Certificate Tab.
– To use an orchestrated appliance end entity profile for the syslog client certificate,
see Logging Template.
– To use a manually added end entity certificate for the syslog client certificate, see
Remote Log Receivers.
Column Description
If you have created an appliance end entity profile, after enrollment with
the EST server is completed, a View Certificate link appears in this column
that allows you to view and download the certificate. A separate row will
appear on the dialog box with a certificate for each appliance for each
profile.
Expiration The date when the certificate expires.
date
Status If certificate enrollment fails, a brief description of the reason for failure
appears in this column, and the View Certificate link does not appear in
the CSR / Certificate column.
Clients Table
Configuration > Overlays & Security > Security > Clients Table
The Clients Table tab provides at-a-glance details about LAN-side client devices in your net-
work, which can assist in monitoring LAN-side hosts and troubleshooting issues. The Clients
table on this tab lists client devices for all appliances in your network or those selected in the
appliance tree. Client devices discovered by RADIUS snooping and/or Network Access Control
(NAC) are listed in the table.
The maximum number of rows displayed in the Clients table is limited to 10,000. The maxi-
mum number of rows displayed for each appliance is 10,000 divided by the total number of
appliances in your network or the number selected in the appliance tree. The following indi-
cators are provided above the table:
The following filters, displayed at the top of the tab, work together to filter the Clients table:
• IP/Subnet – Filters on the specified user device IP address or subnet range (for example,
192.168.11.0/24).
• Segment – Filters on the selected segment. This filter is available only if routing segmen-
tation is enabled.
• MAC Address – Filters on the specified user device MAC address (format XX:XX:XX:XX:XX:XX).
• Effective Role – Filters on the selected user device role.
After selecting the filtering criteria, click Apply. To clear filtering criteria, click Clear.
Descriptions of fields in the Clients table follow.
NOTE: The Clients table does not show real-time data.
Field Description
Field Description
Appliance Name of the appliance for the Network Access Control (NAC)
security settings.
LAN Interface The LAN interface of the appliance to which the NAC policies
are applied.
AAA Profile The AAA profile applied to the appliance.
Auth Type The authentication type applied to the appliance.
To enable or edit Network Access Control (NAC), select one or more appliances from the ap-
pliance tree, and then click the edit icon in the applicable table row.
3. Add or edit the AAA profiles used for authentication. See AAA Profile.
4. Apply the Network Access Control (NAC) policies to the interface labels. See Apply Poli-
cies.
Use 802.1x/MAC tab to add or edit authentication profiles. You should create both 802.1x
authentication and MAC authentication profiles. If the supplicant is 802.1x compliant, the ap-
pliance will use the 802.1x profile to authenticate the supplicant. If the supplicant is not 802.1x
compliant, the appliance will use the MAC profile to authenticate the supplicant.
802.1x Authentication Profile Fields
Field Description
Field Description
4. Click Update.
1. Click Add to add a new MAC authentication profile or click the pencil icon to edit an
existing MAC authentication profile.
NOTE: To delete a profile listed in the table on the Network Access Control (NAC) dialog
box, click the corresponding delete icon (X) in the last column.
2. Complete the following fields:
Field Description
3. Click Update.
Navigate to the Server tab to configure the servers and server groups you want to use to
authenticate the supplicants.
Server
Use the Server tab to add or edit the servers and server groups you want to use to authenticate
the supplicants that are attempting to log in to the network.
Servers Fields
Field Description
3. Click Save.
Navigate to the AAA Profile tab to add or edit AAA profiles. AAA profiles define the authenti-
cation profile and server and server groups you want to use to authenticate supplicants.
Server Group Fields
You can create groups of servers. If one server is not reachable based on the server retry
count configured on the 802.1x/MAC tab, the appliance will try to reach another server.
Field Description
3. Click Save.
Navigate to the AAA Profile tab to add or edit AAA profiles used to authenticate supplicants.
AAA profiles define the authentication profile and server and server groups you want to use
to authenticate supplicants.
AAA Profile
Use the AAA Profile tab to create profiles to map the 802.1x and MAC authentication profile to
a server group you want to use to authenticate supplicants. This profile is used for dynamic
authorization. For example, when a supplicant needs to be reauthenticated or the when the
existing session is disconnected. After you create a AAA profile, you will assign that profile to
an interface label.
You can edit an existing AAA profile or add a new AAA profile.
1. Click Add to add a AAA profile or click the pencil icon to edit an existing AAA profile.
The Edit AAA Profile dialog box opens.
2. Complete the following fields:
Field Description
Apply Policies
Use the Apply Policies tab to modify the policies that are assigned to each interface label.
Supplicants plugged into the LAN port with the assigned interface label will be authenticated
using the policy you select.
Each LAN interface label defined in your Orchestrator deployment is assigned the default au-
thentication policy. The default authentication policy is set to “trusted.” When authentication
is set to “trusted”, no authentication is required to access the network.
4. Click Save.
You will receive a green status message if your policy was successfully applied.
Delete a Policy
To delete a policy from an LAN interface, click the corresponding delete icon (X) in the last
column. The NAC security settings for this LAN interface will return to the default values.
NAC Status
Use the NAC Status subtab to review and monitor the authentication of all supplicants.
Field Description
• EdgeConnect decrypts SSL data using the configured certificates and keys, optimizes the
data, and transmits data over an IPSec tunnel. The peer EdgeConnect appliance uses
configured SSL certificates to re-encrypt data before transmitting.
• Peers that exchange and optimize SSL traffic must use the same certificate and key.
• For the SSL certificates to function, the following must also be true:
– The tunnels are in IPSec or IPSec UDP mode for both directions of traffic.
– In the Optimization Policy, TCP acceleration and SSL acceleration are enabled.
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
• EdgeConnect decrypts SSL data using the configured certficates and keys, optimizes the
data, and transmits data over an IPSec tunnel. The peer EdgeConnect appliance uses
configured SSL certificates to re-encrypt data before transmitting.
• Peers that exchange and optimize SSL traffic must use the same certificate and key.
• Use this page to directly load the certificate and key into this appliance.
– You can add either a PFX certificate (generally, for Microsoft servers) or a PEM cer-
tificate.
– The default is PEM when PFX Certificate File is deselected.
– If the key file has an encrypted key, enter the passphrase needed to decrypt it.
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
• Use this page to directly load the CA certificate into the appliance.
– You can add either a PFX certificate (generally, for Microsoft servers) or a PEM cer-
tificate.
– The default is PEM when PFX Certificate File is deselected.
• EdgeConnect supports:
– X509 Privacy Enhanced Mail (PEM), Personal Information Exchange (PFX), and RSA
key 1024-bit and 2048-bit certificate formats.
– SAN (Subject Alternative Name) certificates. SAN certificates enable sharing of a
single certificate across multiple servers and services.
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
• The appliance generates it locally, and each certificate is unique. This is an ideal option
for Proof of Concept (POC) and when compliance is not a big concern.
• To avoid browser warnings, follow up by importing the certificate into the browser from
the client-side appliance.
• If you already have a subordinate CA certificate (for example, an SSL proxy), you can
upload it to Orchestrator and push it out to the appliances. If you need a copy of it later,
just download it from here.
• If this substitute certificate is subordinate to a root CA certificate, also install the higher-
level SSL CA certificates (into the SSL CA Certificates template) so that the browser can
validate up the chain to the root CA.
• If you do not already have a subordinate CA certificate, you can access any appliance’s
Configuration > Templates & Policies > Applications & SaaS > SaaS Optimization
page and generate a Certificate Signing Request (CSR).
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
– The appliance generates it locally, and each certificate is unique. This is an ideal
option for Proof of Concept (POC) and when compliance is not a big concern.
– To avoid browser warnings, follow up by importing the certificate into the browser
from the client-side appliance.
– If you already have a subordinate CA certificate (for example, an SSL proxy), you can
upload it to the Orchestrator and push it out to the appliances. If you need a copy
of it later, just download it from here.
– If this substitute certificate is subordinate to a root CA certificate, also install the
higher-level SSL CA certificates (via Configuration > Overlays & Security > SSL >
SSL CA Certificates) so that the browser can validate up the chain to the root CA.
– If you do not already have a subordinate CA certificate, you can access any appli-
ance’s Configuration > Templates & Policies > Applications & SaaS > SaaS Op-
timization page and generate a Certificate Signing Request (CSR). The workflow
would basically follow this pattern:
1. Click Generate Certificate Signing Request and complete the Certificate Infor-
mation requested in the dialog box.
2. Save the CSR and the Private Key.
3. Submit the CSR to your enterprise CA to obtain a Subordinate CA Certificate.
4. After approvals are complete and the subordinate CA is in hand, navigate to
the Configuration > Templates & Policies > Applications & SaaS > SaaS Op-
timization page.
5. Under Custom CA Certificate, click Upload and Replace to import the subor-
dinate CA.
Discovered Appliances
Configuration > Overlays & Security > Discovery > Discovered Appliances
This tab lists each appliance that Orchestrator discovers.
• To enable Orchestrator to manage an appliance after you verify its credentials, click Ap-
prove.
• If the appliance does not belong in your network, click Deny. If you want to include it
later, click Show Denied Devices, locate it in the table, and click Discover.
Preconfigure Appliances
Configuration > Overlays & Security > Discovery > Preconfiguration
Use this page to prepopulate flat data files that are matched with appliances as you add them
to your network.
The information in the files is a combination of items found in the Appliance Configuration
Wizard, along with site-specific information such as BGP, OSPF, IP SLA rules, VRRP, interfaces,
and addressing.
You can create a new file or clone (and rename) an existing one. Make any changes with the
built-in editor.
After the appliance is discovered and approved, software upgrade and configuration push are
done automatically.
New or Clone
Field Description
Field Description
EC-Enterprise Licenses
Configuration > Overlays & Security > Licensing > Licenses
• This page lists the appliance model, serial number, appliance name, feature licenses, and
license terms for the appliances selected in the appliance tree.
• You can add, edit, or revoke EdgeConnect (EC) licenses from an appliance.
• A license summary including the number of used licenses and total number of available
licenses is displayed above the table. The expiration date of the Boost license and each
feature license is also listed.
• To assign licenses to one appliance, click the Edit icon next to that appliance.
• To assign licenses in bulk (to all appliances in the table), click Assign Licenses to
Appliances.
NOTE: To assign licenses in bulk, all appliances must be on the same software ver-
sion.
Field Description
EC Select the Add/Replace check box, and then select the EC size from
the list: Mini, Base, Base + Plus, 50 Mbps, 200 Mbps, 500 Mbps, 1
Gbps, 2 Gbps, or Unlimited.
Boost Select the Add/Replace check box, and then enter the amount of
Boost to apply to the EC.
Feature licenses 1. To add a feature license, select the Add/Replace check box.
4. To revoke a license or Boost, select the Revoke check box next to the license or Boost
you want to revoke.
NOTE: If you revoke an EC license from an appliance, Silver Peak will revoke the Boost
license and all feature licenses from that appliance.
NOTE: You must revoke the license from an appliance before you can RMA it. For more
information on how to RMA an appliance, see RMA Wizard.
5. Click Apply.
Licenses
This page lists the appliance model, serial number, appliance name, and feature licenses for
the appliances selected in the appliance tree. You can add, edit, or revoke EdgeConnect (EC)
licenses from an appliance.
EC-Enterprise Licenses
Configuration > Overlays & Security > Licensing > Licenses
A license summary including the number of used licenses and total number of available li-
censes is displayed above the table. The expiration date of the WAN Optimization license and
each feature license is also listed.
NOTE: EdgeConnect stops passing traffic when a license expires.
1. In the appliance tree, select one or more appliances to display in the table.
2. Do one of the following:
• To assign licenses to one appliance, click the Edit icon next to that appliance.
• To assign licenses in bulk (to all appliances in the table), click Assign Licenses to
Appliances.
NOTE: To assign licenses in bulk, all appliances must be on the same software ver-
sion.
Field Description
EC Select the Add/Replace check box, and then select the EC size from
the list: Mini, Base, Base + Plus, 50 Mbps, 200 Mbps, 500 Mbps, 1
Gbps, 2 Gbps, or Unlimited.
WAN Optimization Select the Add/Replace check box, and then enter the amount of
WAN Optimization to apply to the EC.
Feature licenses 1. To add a feature license, select the Add/Replace check box.
4. To revoke a license or WAN Optimization, select the Revoke check box next to the license
or WAN Optimization you want to revoke.
NOTE: If you revoke an EC license from an appliance, Silver Peak will revoke the WAN
Optimization license and all feature licenses from that appliance.
NOTE: You must revoke the license from an appliance before you can RMA it. For more
information on how to RMA an appliance, see RMA Wizard.
5. Click Apply.
EC-Metered Licenses
Configuration > Overlays & Security > Licensing > Licenses
To filter the list, click one of the following buttons:
Button Description
EC-Metered License Display the EC-metered licenses for all appliances selected
in the appliance tree. To filter the list, click one of the
following buttons:
1. In the appliance tree, select one or more appliances to display in the table.
2. Do one of the following:
• To assign licenses to one appliance, click the Edit icon next to that appliance.
• To assign licenses in bulk (to all appliances in the table), click Assign Licenses to
Appliances.
NOTE: To assign licenses in bulk, all appliances must be on the same software ver-
sion.
Field Description
Field Description
Feature licenses 1. To add a feature license, select the Add/Replace check box.
4. To revoke a license or WAN Optimization, select the Revoke check box next to the license
or WAN Optimization you want to revoke.
NOTE: If you revoke an EC license from an appliance, Silver Peak will revoke the WAN
Optimization license and all feature licenses from that appliance.
NOTE: You must revoke the license from an appliance before you can RMA it. For more
information on how to RMA an appliance, see RMA Wizard.
5. Click Apply.
This page lists the maximum outbound bandwidth usage, maximum inbound bandwidth us-
age, and WAN Optimization bandwidth for the account.
To aggregate the usage report, click Summary, Appliance, or Daily, and then select a month
and year.
This page lists the feature license usage report for the account.
To aggregate the usage report, click Summary, Appliance, or Daily, and then select a month
and year.
EC-Metered Licenses
Configuration > Overlays & Security > Licensing > Licenses
To filter the list, click one of the following buttons:
Button Description
EC-Metered License Display the EC-metered licenses for all appliances selected
in the appliance tree. To filter the list, click one of the
following buttons:
• This page lists the appliance model, serial number, appliance name, and feature licenses
for the appliances selected in the appliance tree.
• You can add, edit, or revoke EdgeConnect (EC) licenses from an appliance.
• To assign licenses to one appliance, click the Edit icon next to that appliance.
• To assign licenses in bulk (to all appliances in the table), click Assign Licenses to
Appliances.
NOTE: To assign licenses in bulk, all appliances must be on the same software ver-
sion.
Field Description
Field Description
Boost Select the Add/Replace check box, and then enter the amount of
Boost to apply to the EC.
Feature licenses 1. To add a feature license, select the Add/Replace check box.
4. To revoke a license or Boost, select the Revoke check box next to the license or Boost
you want to revoke.
NOTE: If you revoke an EC license from an appliance, Silver Peak will revoke the Boost
license and all feature licenses from that appliance.
NOTE: You must revoke the license from an appliance before you can RMA it. For more
information on how to RMA an appliance, see RMA Wizard.
5. Click Apply.
Cloud Portal
Configuration > Overlays & Security > Licensing > Cloud Portal
Orchestrator > Orchestrator Server > Licensing > Cloud Portal
The Cloud Portal dialog box is used to register cloud-based features and services, such as SaaS
optimization and EdgeConnect.
NOTE: Orchestrator 9.5.2 and later supports IPv6 and IPv4. To support IPv6, the Cloud Por-
tal URL changed to portal2.silverpeak.cloud. See the Orchestrator 9.5.2 release notes for de-
tails.
NOTE: If you enabled Air-Gap mode, you cannot access the Cloud Portal. You will log in to
the Air-Gap Portal to generate a new account key, which you will provide on this dialog box.
Follow the instructions for enabling Air-Gap and accessing the Air-Gap Portal here: HPE Aruba
Networking Orchestrator Air-Gap User Guide.
• When you purchase one of these services, an Account Name and instructions to obtain
your Account Key are sent to you. You will use these to register your appliances.
• Use of these services requires that your appliances can access the Cloud Portal via the
Internet.
• You can require hardware appliances to be provisioned with the Account Name and Ac-
count Key in order to be discovered.
• You can register a secondary account using the Secondary Accounts button.
• If you subscribed to an AAS License, the license type is displayed. The AAS license sub-
scription determines which features are available in Orchestrator. The license token is
refreshed from Cloud Portal every 24 hours.
• The Orchestrator UUID (universally unique identifier) is available under the Registration
heading on the Cloud Portal dialog box.
Secondary Accounts
Secondary accounts allow you to manage multiple license end dates across a single SD-WAN,
and can be used in the following situations:
• You want to add an account that has a different end date from the existing primary ac-
count in your Orchestrator.
• You want to merge accounts from one Orchestrator to another Orchestrator and have
one SD-WAN fabric to manage.
NOTES:
- Hardware assets must co-reside in the same secondary account where the license resides.
- It is recommended to co-terminate licenses when possible for ease of management.
The primary account is where Orchestrator resides, and secondary accounts are associated
to Orchestrator through the registration process. Hardware must reside in the same account
as the software licenses associated with that hardware. You can register up to 11 secondary
accounts.
As with a primary account, an Account Name and instructions to obtain your Account Key are
sent to you. You will use these to register your appliances to the secondary account. To add a
secondary account click Secondary Accounts, then click +Add, enter the account information,
and click Add. To register the added secondary account, click Save.
Any secondary account changes, such as adding, updating, or deleting accounts, will trigger
the registration process for all secondary accounts, even for those not modified directly in
Orchestrator. This will be evident when a spinning icon is displayed next to “Registered” af-
ter saving any changes. After the registration process is complete, the spinning icon will be
replaced with registration information that Cloud Portal returns to Orchestrator.
Deployment Tab
Configuration > Networking > Deployment
This tab provides summary and detailed views of the selected appliance’s deployment set-
tings.
To change an appliance’s deployment settings, click the Edit icon next to the name of the
desired appliance.
The following table describes the fields on the Summary view of this tab.
Field Description
Inline Router: Uses separate LAN and WAN interfaces to route data
traffic.
Server: Both management and data traffic use the mgmt0 interface.
Outbound Deployment’s total outbound bandwidth in Kbps.
Bandwidth
Inbound Bandwidth Deployment’s total inbound bandwidth in Kbps.
WAN Labels Used Identify the service, such as MPLS or Internet.
LAN Labels Used Identify the data, such as data, VoIP, or replication.
Segment Names of the segments used for this appliance deployment.
License License tier granted for this appliance deployment.
Details Select the information icon to view further deployment details of
an appliance.
The following table describes the fields on the Details view of this tab.
Field Description
Harden – For traffic inbound from the WAN, the appliance accepts
__*only__* IPSec tunnel packets that terminate on an EdgeConnect
appliance. For traffic outbound to the WAN, the appliance __*only__*
allows IPSec tunnel packets and management traffic that terminate on
an EdgeConnect appliance.
DHCP Indicates whether the interface’s IP address is obtained from the DHCP
server.
Field Description
Enable EdgeHA
EdgeHA mode is a high availability cluster configuration that provides appliance redundancy
by pairing two EdgeConnect devices together.
When you configure two EdgeConnect appliances in EdgeHA mode, the resilient cluster acts
as a single logical system for orchestrated WAN functions. It extends the robust SD-WAN mul-
tipathing capabilities, such as Business Intent Overlays, seamlessly across the two devices as
though they were one entity.
With EdgeHA mode, a WAN uplink is physically plugged into a single one of the EdgeConnect
appliances but is available to both in the cluster. For WAN connections that perform NAT
(for example, a consumer-grade Broadband Internet connection), it means that only a single
Public IP needs to be provisioned in order for both EdgeConnect devices in the EdgeHA cluster
to be able to build Business Intent Overlays using that transport resource. The same is true for
orchestrated tunnels to third-party cloud services, such as Zscaler and AWS Transit Gateway.
NOTE: EdgeHA mode provides clustering for WAN-side functions only. You must select and
configure an appropriate LAN-side redundancy mechanism for a given business location.
Available options are VRRP+IP SLA, BGP, and OSPF.
To enable EdgeHA:
NOTE: You can choose any LAN or WAN port combination for this HA Link that is available
on the respective EdgeConnect chassis. You must match the media type and speed for
both ends of the HA link. (For example, 1 Gigabit-Ethernet RJ-45 to RJ-45 or 10 Gigabit-
Ethernet multimode fiber LC-connector-to-LC-connector). Also, note that you cannot use
MGMT ports for the HA Link; only LAN or WAN ports.
For both EdgeConnect appliances in a high availability cluster to be able to share a common
transport connection, you must set the tunnel type to IPSec over UDP mode. This is the default
tunnel mode for all deployments running ECOS 8.1.6/Orchestrator 8.2 or later.
NOTE: For SD-WAN fabrics upgraded from earlier releases, see Tunnel Settings in Orchestrator
(Orchestrator > Orchestrator Server > Tools > Tunnel Settings) to change to IPSec over UDP
mode.
You must configure the same site name for both appliances in the EdgeHA pair so that Or-
chestrator assigns a unique IPSec UPD port number for each appliance.
Typically, in a branch site deployment, you will choose to configure the cluster with VRRP+IP
SLA to modify priority and subnet sharing metrics based on VRRP and WAN interface status.
For more advanced deployments with Layer 3 routers or switching on the LAN side, BGP or
OSPF can be configured. For details, refer to the EdgeHA High Availability Deployment Guide.
LAN-side Monitoring
The IP SLA feature should be configured to monitor the LAN-side VRRP state in order to auto-
matically disable subnet sharing from that appliance in the case of a LAN link failure.
For more information, refer to the IP SLA configuration guide.
– Navigate to Configuration > Overlays & Security > Deployment Profiles, click the
Edit icon next to Label, and make the appropriate changes, or
– Navigate to Configuration > Overlays & Security > Interface Labels) and make
the appropriate changes.
• The change you make to a label propagates automatically. For example, it renames tun-
nels that use that labeled interface.
If the LAN interface has an IPv4 IP address, click V4 to display the DHCP configuration settings.
See V4.
If the LAN interface has an IPv6 IP address, click V6 to display the Router Advertisement set-
tings. See V6.
V4
The following tables describe the various DHCP settings you can configure for LAN interfaces
that have IPv4 IP addresses.
DHCP Server
Setting Description
Setting Description
DHCP/BOOTP Relay
Setting Description
Setting Description
Common DHCP server for all Select this check box to set the default values for all
segments segments.
Setting Description
V6
The following table describe the various router advertisement settings you can configure for
LAN interfaces that have IPv6 IP addresses. The LAN clients can use these options to autocon-
figure IPv6 addresses and to learn default gateway addresses.
NOTE: DHCP for IPv6 is not supported.
Setting Description
Setting Description
Other Flag Select this option to instruct IPv6 hosts to use DHCPv6 to
obtain additional configuration information, such as DNS
server addresses and other network parameters.
Link MTU Set the maximum transmission unit (MTU) size that can be
transmitted without fragmentation. This helps ensure that
all hosts on the network use the same MTU, avoiding issues
related to packet fragmentation and reassembly.
Max Interval Specify the maximum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Min Interval Specify the minimum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Current Hop Limit Set the default hop limit for IPv6 packets sent by hosts on
the network. Hosts use this value to configure their own
hop limit for outgoing packets.
Default Router Preference Select High, Medium, or Low to set the preference level of
the router for use as a default router. Hosts use this value
to prioritize multiple routers on the same link.
Default Router Lifetime Specify the lifetime in seconds of the default route that is
advertised by the router. The hosts use this value to
determine how long the router should be used as the
default gateway.
Reachable Time Specify the time in milliseconds that an IPv6 host considers
a neighbor reachable after receiving a confirmation. This
value maintains accurate and timely reachability
information in the neighbor cache.
Retrans Timer Specify the time in milliseconds between retransmissions of
neighbor solicitation messages. This value reduces the
frequency of retries when attempting to discover or confirm
the reachability of neighbors on the network.
• RA, DHCPv4 Server, and DHCPv4 Relay cannot be enabled if there is an alias interface
configured for the main/primary interface.
• A maximum of 10 prefixes can be configured in the RA configurations per interface.
Setting Description
WAN–side Configuration
Interface mode: Orchestrator release 9.5.2 and later supports IPv4 and IPv6 to meet the
increasing demand for IP addresses. This feature also allows you to deploy appliances that
support both IPv4 and IPv6 for a dual stack solution.
NOTE: The WAN interfaces of factory deployed appliances with ECOS version 9.5.2 and later
support both IPv4 and IPv6 addresses for Zero Touch Provisioning (ZTP). Appliances with pre-
vious versions of ECOS only support IPv4.
IMPORTANT: ZTP for IPv6 is not supported for EC-Vs.
Select one of the following options for each WAN interface:
• DHCPv4 + DHCPv6 – This is a dual-stack mode that supports the simultaneous use of
IPv4 and IPv6 addresses. The IPv6 address is configured dynamically by DHCP on the
primary interface and the IPv4 address is configured dynamically by DHCP on the alias
interface. All properties except Label are inherited from the primary interface and cannot
be edited.
• DHCPv4 + SLAAC – This is a dual-stack mode that supports the simultaneous use of IPv4
and IPv6 addresses. The IPv6 address is configured dynamically by SLAAC on the primary
interface and the IPv4 address is configured dynamically by DHCP on the alias interface.
All properties except Label are inherited from the primary interface and cannot be edited.
NOTE: Only one DHCP configuration option is allowed for each physical interface.
Firewall Zone: Zone-based firewall policies are configured globally on the Orchestrator. A
zone is applied to an Interface. By default, traffic is allowed between interfaces labeled with
the same zone. Any traffic between interfaces with different zones is dropped. You can create
exception rules (Security Policies) to allow traffic between interfaces with different zones.
Firewall Mode: Four options are available at each WAN interface:
– For traffic inbound from the WAN, the appliance accepts __*only__* IPSec tunnel
packets that terminate on an EdgeConnect appliance.
– For traffic outbound to the WAN, the appliance __*only__* allows IPSec tunnel pack-
ets and management traffic that terminate on an EdgeConnect appliance.
VLAN Settings: With Orchestrator release 9.5.2 and later, you can assign multiple IP aliases
to the same VLAN interface ID. Prior to Orchestrator release 9.5.2, Orchestrator only allowed
you to assign one unique IP address to a VLAN ID. This new feature also allows you to assign
VLAN IDs to interfaces in a dual stack solution with SLAAC.
Sub-interfaces behave the same as physical interfaces.
NOTE: If you modify the IP address or subnet mask of a sub-interface, all sub-interfaces and
IP aliases with the same ID will be deleted and added back. The label, segment, and zone will
remain unchanged. There will be a brief outage of all IPs while the interfaces are deleted and
added back.
IP aliases and sub-interfaces will appear in all tabs where interfaces are listed or selectable
(for example, the Dynamic table on the Interfaces tab). The first sub-interface will be the main
interface. Additional IP aliases will be assigned with incremented interface numbers. For
example, the main sub-interface will be wan0.120 and additional IP aliases will be assigned
wan0.120:1, wan0.120:2, and so on.
NAT Settings: To change the NAT setting, click the NAT-related link under the Next Hop field
on the WAN side. The NAT Settings dialog box opens.
Select one of the following options:
• You can change the bandwidth allotted for this appliance by selecting the appropriate
option from the EC drop-down list. Your options are based on the licensing you have
purchased.
• If you have purchased a pool of WAN Optimization for your network, you can allocate
a portion of it in the WAN Opt field on the Deployment dialog box. You can also direct
allocations to specific types of traffic in the Business Intent Overlays.
• To view the licensing and distribution of EdgeConnect and WAN Optimization bandwidth
for your appliances, navigate to the Configuration > Overlays & Security > Licensing
> Licenses tab.
BONDING
Interfaces Tab
Configuration > Networking > Interfaces
The Interfaces tab lists the interfaces for appliances selected in the appliance tree. Fields avail-
able in the table depends on the selected filter button that is located immediately above the
table.
The All button displays all hardware and dynamic interfaces for the selected appliances.
Descriptions of the fields on this tab (All, Hardware, Dynamic, USB LTE) follow:
Field Description
Field Description
Type Port type (RJ45 or SFP). Drop-down box appears on interfaces with
Combo ports. RJ45 is the default for Combo port.
Field Description
Terminology
Interface Description
Interface Description
bvi0 Bridge Virtual Interface. When the appliance is deployed in-line (Bridge
mode), it is the routed interface that represents the bridging of wan0 and
lan0.
bwan Bonded WAN interfaces (as in wan0 + wan1).
tlan 10-Gbps fiber LAN interface.
twan 10-Gbps fiber WAN interface.
Field Description
• When PoE is selected, the PoE Configuration dialog box appears. Use this dialog box to
modify the configuration interfaces on the specified appliance.
The All Interfaces button displays all interfaces for the appliance, including both assigned and
unassigned hardware interfaces. MAC addresses indicate assigned interfaces.
Descriptions of the fields on this dialog box follow:
Hardware
Field Description
Field Description
Dynamic
Field Description
Port Limits: Individual ports can have maximum power draw limits set. Ports that exceed the
power limit are be denied power.
Interface: The name of the interface modified by corresponding parameter settings.
Enable PoE: Specifies the PoE enable status of the correlated interface.
NAT
Configuration > Networking > NAT
NAT allows for multiple sites with overlapping IP addresses to connect to a single SD-WAN
fabric. You can configure SNAT (Source Network Address Translation), DNAT (Destination Net-
work Address Translation), destination TCP, and UDP port translation rules that apply to all
LAN to WAN traffic in the ingress and egress directions. Configured rules apply to all traffic
including tunneled traffic, internet bound traffic, and other passthrough traffic. The following
address translation options are supported:
NOTE: NAT functionality does not apply to the EdgeConnect itself. You can NAT to and from
other IP addresses, but not for the local addresses of the EdgeConnect.
You can view both NAT rules and NAT pools within your network by selecting NAT Rules or
NAT Pools at the top of the page. You can also export a CSV file of your branch NAT traffic.
Select the Edit icon to add rules to your NAT and NAT pools.
NAT Rules
Each NAT rule has a directional field or value. Outbound rules are applied to the traffic flows
initiated from the LAN and destined to the WAN. Inbound rules are applied to the traffic flows
initiated from the WAN and destined to the LAN. They include all tunneled traffic, internet
bound traffic, and other passthrough traffic. Return traffic for a given flow does not require
an additional rule. The destination IP address must be configured for each rule.
NOTE: You must disable advertisements of local, static routes on the LAN side at the site so
routes are completely unique. Additionally, you must configure announce-only static routes
for your NAT pools and advertise them to the WAN by allowing those routes in your “Redis-
tribute routes to SD-WAN fabric” route map.
Complete the following steps to add a rule to your NAT:
1. On the NAT tab, click the edit icon next to an appliance name.
The NAT dialog box opens.
2. Click Add Rule.
3. Enter the following values in the table by selecting any of the columns.
Field Description
Priority Order in which the rules are executed; the lower the priority, the
higher the chance your NAT rule will be applied.
LAN Interface Name of the LAN interface the NAT rule is using. This is
configurable for an outbound NAT rule only.
Segment Name of the segment being used.
Direction Select the direction the traffic is going:
4. Click Save.
NAT Pools
You also have the option to configure a NAT pool. Complete the following steps to create a
NAT pool:
1. On the NAT tab, click the edit icon next to an appliance name.
The NAT dialog box opens.
2. Click NAT Pools.
The NAT Pools dialog box opens.
3. Click Add.
4. Enter the following values in the table by selecting any of the columns.
Field Description
5. Click Save.
A confirmation message appears at the bottom of the screen.
VRRP Tab
Configuration > Networking > VRRP
This tab summarizes the configuration and state for appliances deployed with Virtual Router
Redundancy Protocol (VRRP).
VRRP specifies an election protocol that dynamically assigns responsibility for a virtual router
to one of the VRRP routers on a LAN. The VRRP router controlling the IP address(es) associated
with a virtual router is called the Master and forwards packets sent to these IP addresses. The
election process provides dynamic failover in the forwarding responsibility should the Master
become unavailable. This allows end hosts to use any virtual router IP addresses on the LAN
as the default first-hop router. The advantage gained from using VRRP is a higher availability
default path without configuring dynamic routing protocols such as BGP or OSPF.
• If you set the VRRP virtual IP (VIP) to a subnet that is different than that of the LAN physical
interfaces, do not use static routes on the LAN side.
• By default, EdgeHA operates within the IPv4 link-local address range. If you configure the
LAN interfaces to use the same range, ensure that there are no duplicate IP addresses.
• If the LAN physical interfaces are set to the link-local subnet 169.254.0.0/16, make sure
that this subnet is not shared via route-map filtering.
• DHCP server, DHCP relay, or other management services on the VRRP VIP with a different
subnet are not supported.
VRRP Settings
Field Description
Field Description
Advertisement Timer The time interval between sent advertisements. For version 2,
the time is measured in seconds, and the default is 1 sec. For
version 3, the time is measured in centi-seconds, and the
default is 1 centi-sec. 1 centi-sec = 10ms.
Priority Config The greater the number, the higher the priority. The appliance
with the higher priority is the VRRP Master.
Priority State The current VRRP priority, which can be influenced by IP SLA
rules.
Preemption Leave this selected/enabled so that after a failure, the
appliance with the highest priority comes back online and again
assumes primary responsibility.
Authentication String Clear text password for authenticating VRRP version 2 group
members. You cannot use an authentication string if you are
using VRRP version 3.
Description Free-form text field where you can enter a description of the
VRRP instance.
Details Click the info icon in this column to view the following details
about the VRRP instance.
WCCP Tab
Configuration > Networking > WCCP
Use this tab to view, edit, and delete WCCP Service Groups.
Web Cache Communications Protocol (WCCP) supports the redirection of any TCP or UDP
connections to appliances participating in WCCP Service Groups. The appliance intercepts
only those packets that have been redirected to it. The appliance optimizes traffic flows that
the Route Policy tunnelizes. The appliance forwards all other traffic as pass-through or pass-
through-unshaped, as per the Route Policy.
Field Description
Field Description
Forwarding Method Also known as the Redirect Method. Packet redirection is the process
of forwarding packets from the router or L3 switch to the appliance.
The router or L3 switch intercepts the packet and forwards it to the
appliance for optimization. The two methods of redirecting packets
are Generic Route Encapsulation (GRE) and L2 redirection.
either allows the appliance and the router to negotiate the best
option. You always should select either. During protocol
negotiation, if the router offers both GRE and L2 as redirection
methods, the appliance will automatically select L2.
Field Description
Router IP IP address of the WCCP router. For Layer 2 redirection, use the
physical IP address of the interface that is directly connected to the
appliance. For Layer 3 redirection, consider using a loopback IP. It is
not recommended to use VRRP or HSRP IPs as router IPs.
Field Description
Assignment Detail This field can be used to customize hash or mask values. If you have
only one appliance, or if you are using route-map or subnet sharing
to tunnelize, use the default LAN-ingress setting.
If there is more than one active appliance and you are using TCP-IP
auto-optimization:
Use WAN-ingress for WCCP groups that are used to redirect inbound
traffic.
Field Description
either, which enables the appliance and router to negotiate the best
method for assignment. This is preferred. If the router offers both
hash and mask methods, the appliance will select the mask
assignment method.
The Hash and Mask areas are accessible only when you select custom in the Assignment
Detail field.
PPPoE Tab
Configuration > Networking > PPPoE
Point-to-Point Protocol over Ethernet (PPPoE) is a network protocol for encapsulating PPP
frames inside Ethernet frames. It is used mainly with DSL services where individual users
connect to a DSL modem over Ethernet.
Field Description
Ethernet Device Specifies the physical interface to use for sending the protocol.
Generally, this is a WAN-side interface.
Password This is set up with your Internet Service Provider (ISP).
PPPoE Name Name is ppp followed by a numerical suffix from 0 to 9.
User Name This is set up with your Internet Service Provider (ISP).
Generally, this is all the configuration required. If your ISP is fine-tuning the access, you might
be asked to configure some of the Optional Fields, below.
Field Description
SERVER – Accept the ISP’s DNS. This then overrides the EdgeConnect
DNS configuration.
Field Description
• Click Config to display configuration details associated with the local appliance. For field
descriptions, see Enable or Edit a USB LTE Modem.
• Click Status to display the status of each appliance and additional details including:
Field Description
TIP: Select the Hide Missing Interfaces check box in the top-right corner of the tab to filter the
list to display only those appliances assigned an interface. Clear the Hide Missing Interfaces
check box to display all interfaces.
1. If the USB LTE modem is not plugged into an appliance, plug the modem into the appli-
ance now.
The USB LTE modem will be in the Down state.
2. Navigate to Configuration > Networking > USB LTE.
3. Click the edit icon next to the appliance on which you want to enable or edit a USB LTE
modem.
The Edit LTE Interface dialog box opens.
4. Configure the following elements as needed:
Field Description
Interface The name of the cell interface. The appliance shows cell0, cell1,
cell2, and cell3. Only cell0 is used for the USB LTE modem.
You must select and configure the cell interface name on the
Deployment page. FW Model must be set to Stateful. Click
Deployment in the tab header to configure the cell interface.
Admin Indicates whether the interface is Up or Down. The USB LTE
modem ships in the Down state.
Generation Set the cellular modem to either auto, 4G, or 3G.
APN The Access Point Name for the interface. Consult your network
provider for a list of possible values. If a specific APN is not
required, select default.
5. Click Save.
Loopback Interfaces
Configuration > Networking > Loopback Interfaces
The loopback feature enhances reliability and security by enabling you to access your net-
work using a single static IP address. If one interface goes down, you can access all interfaces
through the single static IP address.
To add a loopback interface to your network:
Field Description
Field Description
5. Click Add.
Loopback Orchestration
Configuration > Networking > Loopback Orchestration
Use the Loopback Orchestration tab to create a pool of loopback addresses from which Or-
chestrator can automatically create loopback interfaces. You can assign IP addresses from the
pool to each appliance in the network.
IMPORTANT: Loopbacks must be configured consistently on all appliances. Loopbacks are
used for IP SLA source IP, DNS Proxy source IP, and other management functions, such as
TACACS, NetFlow, and SNMP. You must create a loopback label and management zone before
you start setting up loopback orchestration. Be sure to configure a unique LAN-side label (such
as “Loopback”) for the orchestrated loopback interfaces. If you use the built-in zone-based
firewall, you should also configure a dedicated firewall zone such as “Management”.
You can select a segment in the Segment drop-down list to filter loopback interfaces in the
table. This list includes all segments configured on the Routing Segmentation (VRF) tab. Select
All to display all loopback interfaces.
The following table describes the fields for each loopback interface listed on the Loopback
Orchestration tab.
Field Description
Field Description
Additional information:
• When an appliance is removed from the Orchestrator, the associated loopback address
is retired and moved to Deleted status. If the appliance is later re-added to the Orches-
trator, the original loopback IP is restored to the appliance.
• If you configure regional loopbacks, and then an appliance is moved from one region
to another region, the loopback for the appliance is retired and moved to Deleted sta-
tus. If the appliance is later moved back into the original region, the original loopback is
restored.
1. From the Segment drop-down list, select the segment to which you want to apply the
new loopback interface.
2. Select +Add Loopback Interface.
The Loopback Interface dialog box opens.
The selections you make on this dialog box will be applied to the segment selected on
the Loopback Orchestration tab.
NOTE: You can create more than one loopback interface for a segment. However, you
can create only one unique loopback range per segment.
3. Optionally, you can do the following:
• Select a label from the Label drop-down list. This list includes all LAN-side interface
labels configured on the Interface Labels tab.
NOTE: Use a dedicated “Loopback” label. Do not re-use an existing LAN-side label. If your
system does not already have a “Loopback” or similar label, you should create one.
• Select a firewall zone from the Zone drop-down list if you want the loopback inter-
face to be part of a specific firewall zone. This list includes all zones configured in the
Firewall Zone Definition dialog box. If you do not select one, the system-provided
Default zone will be used.
• Select a region from the Region drop-down list. This list includes all regions con-
figured on the Regions tab. If you do not select one, the system-provided Global
pseudo-region will be used.
4. Select the Management check box if you want management applications running on the
appliance to use the loopback interface. This setting also causes the Orchestrator tree
to display the Management IP when you hover over the appliance.
5. Click OK.
The new loopback interface is added to the table on the Loopback Orchestration tab.
1. Click the link in the Loopback Pool column for the appropriate loopback interface.
The Loopback Pool dialog box opens.
2. In the Subnet IP field, enter the subnet IP address you want to use for the loopback pool.
3. Click Update.
NOTE: Orchestrator immediately begins to reassign loopback IPs to all appliances. If
the appliances were using the existing loopback to communicate with Orchestrator, you
might see the appliance disconnect and then reconnect to the Orchestrator. It is recom-
mended that you make loopback changes within a maintenance window.
Use the Virtual Tunnel Interfaces (VTI) tab to manage VTIs for your appliances. A VTI is a tun-
neling protocol that does not require a static mapping of IPSec sessions to a physical interface.
The tunnel endpoint is associated with a tunnel interface that enables a constant, secure, and
stable connection throughout your network. With this feature, you can establish IPSec UDP
SD-WAN tunnels nested within third-party IPSec tunnels (“tunnel-in-tunnel”). IPv6 is supported
for outer tunnel; inner tunnel mode must be IPSEC_UDP.
NOTE: Tunnel-in-tunnel capabilities require that your appliances are running ECOS 9.5.x.x or
later.
• The table on this tab lists all appliances in your network or those selected in the appliance
tree.
• The columns are populated if a VTI has been set up for the appliance.
• An appliance will be listed more than once if multiple VTIs have been set up for the ap-
pliance.
To create a VTI or modify an existing one for an appliance, click any edit icon associated with
the appliance. The VTI dialog box opens.
Use the following procedures to configure a VTI with an associated tunnel in Orchestrator.
Add a VTI
1. Click Add.
The Add VTI Interface dialog box opens.
2. Complete the following fields as appropriate.
Field Description
Segment Segment to associate with the VTI. This field is enabled only if
Routing Segmentation is enabled.
Field Description
Interface Identifier of the VTI. For example, to assign vti200 as the identifier,
enter 200 in the field.
The IP/Mask alias is associated with the IP/Mask configured for the
VTI. It assumes the zone of the associated VTI. You can configure any
routable address for the IP address alias.
Field Description
(Alias) Label Interface label to associate as an alias with the VTI. When you click
the +IP link, the Label field moves from the right of the IP/Mask
fields to the right of the IP/Mask Alias fields.
NOTE: This field and the +IP link are displayed only if the appliance
is running ECOS 9.5.x.x or later.
NOTE: Only one label can be specified for either the IP/Mask or
IP/Mask alias (not both). Also, you cannot assign the same label to
any other WAN-side interface.
Auto Distribute Indicates whether the WAN-side VTI will be automatically
redistributed into BGP. This feature is enabled by default.
3. To change the default NAT setting (Not behind NAT), click the Not behind NAT link.
NOTE: The NAT-related link is displayed only if the appliance is running ECOS 9.5.x.x or
later.
The NAT Settings dialog box opens.
1. Select NAT if the appliance is behind a NAT-ed interface or select the last option
and enter an IP address to assign a destination IP for tunnels being built from the
network to this VTI interface.
2. Click OK.
4. On the Add VTI Interface dialog box, click Add.
5. On the VTI dialog box, click Save.
Edit a VTI
1. Click the edit icon associated with the VTI you want to modify.
1. As appropriate, select Not behind a NAT, NAT, or select the last option and enter
an IP address to assign a destination IP for tunnels being built from the network to
this VTI interface.
2. Click OK.
Delete a VTI
To delete a VTI listed in the table, click the corresponding delete icon (X) in the last column.
• These defaults apply to the LAN interfaces in Deployment Profiles that specify Router
mode.
• There are three choices:
– No DHCP/No RA.
– Each LAN interface acts as a DHCP Server.
NOTE: If you enable DHCP Failover, you must use the same interface label for each
physical interface.
– The EdgeConnect appliance acts as a DHCP/BOOTP Relay between a DHCP server
at a data center and clients needing an IP address.
• On the Configuration > Overlays & Security > Deployment Profiles tab, the selected
default displays consistently under each LAN–side IP/Mask field.
For any LAN–side interface, you can override the global default by clicking the DHCP-
related link under the IP/Mask field and changing the values or selection.
• Changes you save to the global default only apply to new configurations.
• To view or revise the list of reserved subnets, select Monitoring.
• Before you can configure DHCP, you must navigate to Management Services and select
an interface for DHCP Relay. DHCP relay forwards DHCP messages between clients and
servers that are not on the same local network or subnet. This is particularly useful in
larger networks where a single DHCP server needs to manage IP address assignments
across multiple subnets. See Management Services for more information.
If the LAN interface has an IPv4 IP address, click V4 to display the DHCP configuration settings.
See V4.
If the LAN interface has an IPv6 IP address, click V6 to display the Router Advertisement set-
tings. See V6.
The following tables describe the various DHCP settings you can configure for LAN interfaces
that have IPv4 IP addresses.
DHCP Server
Field Description
DHCP Pool Subnet/Mask Enter the DHCP pool subnet and mask IP addresses.
Subnet Mask Mask that specifies the default number of IP addresses
reserved for any subnet. For example, entering 24 reserves
256 IP addresses.
Field Description
Exclude first N addresses Specifies how many IP addresses are not available at the
beginning of the subnet’s range.
Exclude last N addresses Specifies how many IP addresses are not available at the end
of the subnet’s range.
Default lease, Specify, in hours, how long an interface can keep a
Maximum lease DHCP–assigned IP address.
Default gateway Indicates whether the default gateway is being used.
DNS server(s) Specifies the associated Domain Name System servers.
NTP server(s) Specifies the associated Network Time Protocol servers.
NetBIOS name server(s) Used for Windows (SMB) type sharing and messaging. It
resolves the names when you are mapping a drive or
connecting to a printer.
NetBIOS node type NetBIOS node type of a networked computer relates to how
it resolves NetBIOS names to IP addresses. There are four
node types:
DHCP/BOOTP Relay
Field Description
Field Description
Distinct DHCP server per Select this option to override the DHCP relay configuration
segment set in the Manages Services tab with the settings you select
in this dialog box.
Enable Option 82 When selected, inserts additional information into the
packet header to identify the client’s point of attachment.
This setting applies to all LAN-side interfaces on this
appliance.
Field Description
V6
The following table describe the various router advertisement settings you can configure for
LAN interfaces that have IPv6 IP addresses. The LAN interface will use these options to auto-
configure IPv6 addresses and to learn default gateway addresses.
Setting Description
Setting Description
Other Flag Select this option to instruct IPv6 hosts to use DHCPv6 to
obtain additional configuration information, such as DNS
server addresses and other network parameters.
Link MTU Set the maximum transmission unit (MTU) size that can be
transmitted without fragmentation. This helps ensure that
all hosts on the network use the same MTU, avoiding issues
related to packet fragmentation and reassembly.
Max Interval Specify the maximum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Min Interval Specify the minimum interval in seconds between
unsolicited RA messages. This helps to control the
frequency of RA messages.
Current Hop Limit Set the default hop limit for IPv6 packets sent by hosts on
the network. Hosts use this value to configure their own
hop limit for outgoing packets.
Default Router Preference Select High, Medium, or Low to set the preference level of
the router for use as a default router. Hosts use this value
to prioritize multiple routers on the same link.
Default Router Lifetime Specify the lifetime in seconds of the default route that is
advertised by the router. The hosts use this value to
determine how long the router should be used as the
default gateway.
Reachable Time Specify the time in milliseconds that an IPv6 host considers
a neighbor reachable after receiving a confirmation. This
value maintains accurate and timely reachability
information in the neighbor cache.
Retrans Timer Specify the time in milliseconds between retransmissions of
neighbor solicitation messages. This value reduces the
frequency of retries when attempting to discover or confirm
the reachability of neighbors on the network.
Setting Description
Setting Description
Autonomous flag Select whether the prefix can be used by hosts for SLAAC.
When set to true, hosts can use the prefix to generate their
own IPv6 addresses.
Onlink flag Specifies whether the prefix is on-link, which affects how
hosts handle routing for addresses within the prefix. If set
to true, hosts assume that addresses within the prefix can
be reached directly on the local network segment.
Valid Lifetime Specify the duration in seconds for which the advertised
prefix is valid.
Preferred Lifetime Specify the duration in seconds (relative to the time the
packet is sent) that addresses generated from the prefix via
stateless address auto-configuration remain preferred.
DHCP Leases
Configuration > Networking > DHCP Leases
This tab lists the IP addresses that are currently being leased from the DHCP pool.
• abandoned: The IP address was previously assigned to a client, but the lease has ex-
pired, and the client has not renewed it. The IP address is not immediately available for
reuse and may go through a waiting period before being returned to the free pool.
Each DHCP server of a failover pair acts as a backup for the DHCP leases of its peer. For
example, the DHCP server of EdgeConnect-1 hands an IP lease to a client 172.23.2.50. This
IP address shows as active on both of the EdgeConnect-1 and EdgeConnect-2 DHCP Failover
peer servers.
Preparation
Before starting this process, record the IP addresses for the EdgeConnect LAN interfaces that
you plan to use for the DHCP Failover servers. Use the same interface label for each physical
interface.
NOTE: DHCP failover is time sensitive. For DHCP failover to function properly, both the Primary
and Secondary DHCP servers must be configured to use the same NTP server.
Procedure
On the DHCP Failover dialog box of each EdgeConnect, configure the settings listed below to
provision your DHCP failover servers.
NOTE: In a DHCP Failover configuration, if failover is checked but the ‘my IP’ and ‘peer IP’ are
not provided, and you try to remove the pair, the system complains that ‘My IP’ and ‘Peer IP’
need to be added because failover is checked. In this case, uncheck failover, save the changes,
and then remove the pair.
Each failover group must be configured on a per physical interface basis. For example, if you
select the DHCP Server for any of the LAN0 subnets and configure the Failover Settings, then
those failover settings are retained for all the DHCP servers under LAN0 interfaces. If LAN0 has
VLAN2301 and VLAN2302 on it, they would have the same DHCP failover settings. Likewise,
a LAN2 interface DHCP server has its own failover settings. Use the examples below as a
reference for how to configure DHCP failover settings. You can also use a pre-configuration
template to standardize DHCP failover settings.
• Active-Backup Pair: In DHCP Failover mode, you are deploying two DHCP servers, des-
ignated as “active” and “backup.” The Primary DHCP server does not always service the
requests. The active server handles all DHCP requests and maintains the DHCP lease
database.
• SPLIT: The configuration option that specifies the percentage split of the DHCP requests
that each EdgeConnect handles. The SPLIT values are 0 to 256. The default of 128 dis-
tributes 50% of the load to each DHCP Failover server.
• Lease Assignment and Failover: The active server assigns IP addresses and other con-
figuration parameters to clients. If the active server fails, the backup server seamlessly
takes over, ensuring uninterrupted DHCP service.
• Lease Database Synchronization: The active server continuously synchronizes its
DHCP lease database with the backup server. This ensures that the backup server has
the latest information and can take over without any lease conflicts or disruptions in
case of a failover.
• Real-time Updates: The active DHCP server sends real-time updates to the backup
server whenever a lease is assigned, renewed, released, or expires. This ensures that
both servers have the most up-to-date information.
• Full Synchronization: Periodically, a full synchronization of the DHCP lease database is
performed between the active and backup servers. This acts as a safeguard to ensure
complete consistency in case any updates were missed during real-time synchronization.
FAQs
In a split-brain scenario, would both EdgeConnects provide IP addresses for DHCP re-
quests?
A split-brain scenario is when the DHCP Failover servers are not communicating and synchro-
nizing their data. Once the DHCP Failover servers detect the peer is unavailable, both serve
all clients. New clients get DHCP offers from both. The client chooses one. Client DHCP lease
renewal is different. If the EdgeConnect that provided the previous DHCP lease is not respond-
ing, the renewal fails for its clients. If the client eventually sends out new DHCP Requests (DORA
process Discover-Offer-Request-Ack), an active EdgeConnect responds.
In a split-brain scenario, could an EdgeConnect assign a duplicate IP to a second de-
vice?
No. The EdgeConnect DHCP-Server uses a standards-based implementation that provides a
mechanism to avoid duplicate IP addressing scenarios. EdgeConnects do a standard ARP re-
quest prior to issuing DHCP requests, thus preventing assignment of duplicate IP addresses.
What happens if one sub-interface is disabled?
If a disabled sub-interface whose IP address is not configured as My IP under the failover
settings, the DHCP server does not provide DHCP services for that sub-interface range. If a
disabled sub-interface whose IP address is configured as My IP under the failover settings,
then DHCP failover is triggered for all the DHCP servers configured on that interface. This
causes the local DHCP server to be unreachable from the DHCP peer perspective. The peer
DHCP server then serves all new clients and honors the DHCP renewals that were issued by
the previous DHCP server that is now unreachable. Likewise, if the physical interface goes
down or the peer IP is unreachable, then the DHCP failover trigger happens.
Field Description
Field Description
Link Aggregation
Configuration > Networking > Link Aggregation
The Link Aggregation tab displays channel group and link aggregation details for appliances
selected in the appliance tree.
Link aggregation combines data from multiple physical or virtual interfaces into a channel
group, which provides a single high-speed link. Configuring link aggregation adds failover
redundancy to the interfaces in the channel group.
IMPORTANT: If you aggregate interfaces that are currently in use, those interfaces are re-
moved from deployment before aggregation occurs. When attempting to apply channel group
additions or changes on the Link Aggregation dialog box, a confirmation dialog box opens that
gives you the choice to proceed with aggregating the interfaces or to cancel your link aggre-
gation changes.
The table on the Link Aggregation tab displays the following information:
Column Description
Column Description
LACP Rate Affects the timeout and the rate at which the LACP partner
(switch) is requested to send LACPDU packets.
For fast, one packet per second, and timeout after three
seconds.
LACP System Priority Priority number used to break ties with the LACP partner. This
value can be set from 1 to 65535 with the lowest number
having the highest priority. The default value is 65535.
Comment Additional information about the channel group.
State Details Provides status information on the channel group, including
details about the channel group (bonded interface) state and
port (interface) states. Click the info icon to open a dialog box
that displays this status information.
The Channel group state tab on the dialog box includes three
status indicators: Link status, LACP status, and Channel group
status. (LACP status is displayed only in dynamic mode
[LACP mode].) The Channel group status reflects the Link status
and LACP status. If either is down, the Channel group status
will be down. The LACP status reflects the LACP statuses on the
Port states tab. If the LACP statuses of all interfaces are down,
the LACP status on the Channel group state tab will be down.
The State Details icon is also displayed in the table on the Link
Aggregation dialog box. The same dialog box opens if you click
it there.
The Channel Groups Status column displays the current status of the channel group (up, down,
or pending). Pending status indicates that the link aggregation configuration has not yet been
applied, and the state of the link aggregation is not known at this time.
Column Description
Channel Group (interface) Select a name for the channel group from the drop-down
name list (blan0, blan1, bwan0, or bwan1).
Column Description
Interfaces to be grouped From the drop-down lists, select one, two, three, or four
interfaces to include in the channel group.
3. Click Add.
To delete a channel group listed in the table on the Link Aggregation dialog box, click the
corresponding delete icon (X) in the last column.
Cluster Profiles
Configuration > Networking > Cluster Profiles
On this tab you can view all cluster profiles that you have configured. Cluster profiles allow
you to manage multiple EdgeConnect appliances as a cluster and orchestrate flow redirection
within a cluster. A cluster profile contains configuration settings that are applied to a cluster.
Each peer in a cluster then inherits those same settings. For more information on clusters see,
Clusters. Cluster profiles also do the following:
Orchestrator comes with a built-in cluster profile called “Profile [EdgeHA]” and all EdgeHA ap-
pliances are automatically configured using this profile. Flow redirection is disabled for this
profile because EdgeHA does not support Active/Active deployments.
The following table describes the information displayed on the Cluster Profiles tab for each
cluster profile.
Field Description
Field Description
Field Description
3. Click Save.
For information on applying cluster profiles to clusters, navigate to Configuration > Network-
ing > Clusters, or see Clusters.
Clusters
Configuration > Networking > Clusters
On this tab you can view all clusters and apply profiles to clusters. There is also a link to the
Cluster Profiles tab where you can create cluster profiles. Clusters are created using Site/Clus-
ter Names, and the Site/Cluster name becomes the identifier for a cluster. All appliances with
the same Site/Cluster Name are part of the same cluster. Tunnels are not formed between
appliances with the same Site/Cluster Name.
• If you plan to create clusters and you have previously used the Site setting to prevent
tunnels from forming between EdgeConnect appliances at different sites, you need to
use tunnel exceptions to prevent tunnels from forming between the appliances.
• Starting with release 9.5, Site/Cluster Names are used to create Locations in HPE SSE.
IMPORTANT: You need to configure a Site/Cluster Name for EdgeHA pairs. The Site/Cluster
Name must match precisely for each appliance in the pair.
IMPORTANT: Starting with release 9.5, Site Names are called Site/Cluster Names.
You can apply cluster profiles to clusters. Cluster profiles do the following:
Field Description
Field Description
Profile Shows the configuration settings of the cluster profile applied to the
cluster.
Name - The name of the cluster profile.
Interface/label - The interface label that is used for inter-cluster
synchronization when this cluster profile is applied to a cluster.
Flow redirection - Indicates whether flow redirection is enabled for
the cluster or not.
Wait time - This value (in milliseconds) is used in conjunction with
flow redirection to control how long the system waits for an update
from other cluster peers before redirecting a flow.
User session sync - Indicates if user session synchronization is
enabled or disabled for the cluster profile.
Status - Indicates whether Orchestrator has pushed configuration
settings in the cluster profile to all of the appliances in the cluster or
not.
If there are any active alarms for appliances in the cluster, those are
listed. If you click the linked alarm information, the Alarms tab opens
and is filtered to show only the active alarms for the cluster and the
affected appliances.
Peers Shows the following information about each peer in the cluster:
Appliance - Name of the appliance.
IP - IP address of the appliance.
Interface - Interface label for the appliance.
The reachability status between an appliance and each peer in the
cluster (Reachable or Unreachable).
• You can assign a Site/Cluster name when setting up a new appliance using the Appliance
Configuration Wizard (Configuration > Overlays & Security > Discovery > Configura-
tion Wizard).
• You can assign a Site/Cluster name to a specific appliance by accessing the System Set-
tings for the appliance from either the appliance tree or the System Information tab.
1. In the appliance tree, locate an appliance and click the menu button, then click Sys-
tem Information. Or, on the System Information tab (Administration > Software
> Upgrade > System Information), click the edit icon for an appliance.
The System Information dialog box opens.
2. Click System Settings.
3. To add an appliance to a cluster, in the Site/Cluster name field enter the name of
the cluster to add the appliance to.
4. To remove an appliance from a cluster, in the Site/Cluster name field delete the
name of the cluster to remove the appliance from it.
5. Click Save.
• You can assign a Site/Cluster name to multiple appliances on the Cluster tab or on the
Tunnels tab.
1. From either the Cluster tab or the Tunnels tab, click Sites/Clusters.
The Appliance Site/Cluster Info dialog box opens.
2. To add an appliance to a cluster, find the appliance in the list. Click in the Site/Cluster
column and enter the name of the cluster to add the appliance to.
3. To remove an appliance from a cluster, find the appliance in the list. Then click in
the Site/Cluster column and delete the name of the cluster to remove the appliance
from it.
4. Click Apply.
Bridge Groups
Configuration > Networking > Bridge Groups
The Bridge Groups tab displays details about configured bridge groups for appliances selected
in the appliance tree. With a bridge group you can create a bridged (switched) interface while in
inline router mode on the LAN side of an EdgeConnect OS. Doing this achieves the following:
• You can define bridging between multiple EdgeConnect SD-WAN LAN side physical inter-
faces, similar to switching between ports on a switch.
• Creates a BVI (Bridged Virtual Interface), so that the devices in the bridge group can use
the IP address of the BVI as a default gateway to other IP networks.
In Orchestrator, BVI interfaces are referred to as “slan” and there are four predefined inter-
faces that you can use for a bridge group (slan0, slan1, slan2, and slan3). You can configure the
BVI with the same parameters available on physical or sub-interfaces, such as segmentation,
firewall zones, labels, DHCP server and relay, VRRP, BGP, OSPF, multicast, and branch NAT. If
a bridge group is configured for an appliance, it is available to add as a LAN interface on the
Deployment tab (Configuration > Networking > Deployment).
The following items are not currently supported with bridge groups:
• VXLAN
• Spanning Tree Protocol (STP).
WARNING: EdgeConnect provides no direct layer 2 loop prevention. The LAN segment
must be loop free.
• VLAN tagged BVI interfaces or sub-interfaces.
• Network Access Control (NAC)
NOTE: All bridged unicast traffic is subject to policy and will appear in the flow table.
The table on the Bridge Groups tab displays the following information:
Column Description
Field Description
Bridge Group (interface) Select a name for the bridge group from the drop-down list
name (slan0, slan1, slan2, or slan3).
Interfaces to be grouped Drag interfaces that you want to include in the bridge group
from the __Available box to the Grouped box. You can include
up to 16 interfaces.
MTU Specify the MTU size (in bytes) to be applied to all interfaces in
the group. The default size is 1500 bytes.
Admin status Select up or down. The default is up. Selecting down takes the
BVI out of service.
Comment (Optional) Provide additional information about the bridge
group.
3. Click Add.
After you have added the bridge group (slan interface), you must navigate to the Deployments
tab (Configuration > Networking > Deployment) and configure the slan interface for use.
Regions
Configuration > Overlays & Security > Regions
Use this tab to add or remove regions from the SD-WAN fabric and configure regional routing.
The regions within your SD-WAN fabric can represent geographical regions, administrative
regions, or a set of sites in the network that have common business goals.
Regional Routing
When enabled, regional routing enables you to manage your SD-WAN fabric by regions. It
involves intra-region and inter-region route distribution across the SD-WAN fabric. The regions
within your network can represent geographical regions, administrative regions, or a set of
sites in the network that have common business goals. You can provide different Business
Intent Overlay for each region by enabling regional routing and customizing BIOs per region.
The following diagrams show examples of different regional network topologies you can build
by enabling regional routing.
You can enable regional routing within your Orchestrator UI. Navigate to the Regions tab and
click Enable Regional Routing. The Regional Routing dialog box displays. Move the toggle to
enable regional routing.
View Status
Click View Status to view the status of the added or updated appliances to regions.
Edit Regions
Complete the following steps to add a region or edit existing regions that you want to add to
your overlays.
1. Click the Edit icon next to the region you want to edit.
2. Enter the region name.
3. Click Save.
Navigate to the Business Intent Overlay tab to make further customizations to your regions
and overlays.
Routing Segmentation
Configuration > Networking > Routing > Routing Segmentation (VRF)
Use this tab to enable and disable routing segmentation across your network and apply unique
configuration to your segments. Routing segmentation allows for the configuration of VRF
(Virtual Routing and Forwarding)–style Layer 3 segmentation in your SD-WAN deployments.
Note the following before configuring routing segmentation in Orchestrator:
• You must upgrade all EdgeConnect appliances and Orchestrator to version 9.0.
• All EdgeConnects must be configured to Inline Router mode.
• If a new appliance has been added to your network, or if an existing appliance has been
replaced, you need to upgrade the appliance software to the appropriate version running
in the network.
• After upgrading, segmentation is disabled by default. You will have to enable it on this
tab.
• Regardless of whether segmentation is enabled or disabled, a Default segment is auto-
matically created when you upgrade to 9.0.
• The system-generated Default segment cannot be deleted.
• After you enable routing segmentation, all existing configuration across your network is
associated with the Default segment.
Segment Configuration
You can uniquely configure your segments by specifying the following on this page:
NOTE: Inter-Segment Routing & DNAT and Inter-Segment SNAT are applicable only if you
are using different segments.
The following sections provide more details.
Overlays & Breakout Policies for Segments
Use this dialog box to configure overlays and breakout policies for your segments. This con-
figuration determines the overlays used by each segment when traffic is originating from that
segment and sent over the SD-WAN fabric to other sites. This configuration is also used when
traffic breaks out locally to the Internet and Cloud Services using the Preferred Policy Order
on the Business Intent Overlay (BIO) tab. For traffic to match what is on the specified BIO
tab, ensure the following two conditions are true:
The overlays are arranged by priority defined in the Match field in the Overlay Configuration
dialog box on the BIO page. You can specify if you want to include or skip the segment for each
overlay by clicking Include or Skip icon in the table cell. By default, all overlays are included
for all configured segments.
Include and Skip
If you want to skip an overlay, click the enabled Include icon and Skip appears grayed out. The
segment will not be applied to the specified overlay. Click Skip again to include the segment;
it will turn back to green. If an overlay is set to Skip, traffic will not match that overlay and
moves to the next prioritized BIO. Additionally, if no BIOs match, traffic is dropped.
TIP: If overlay is set to Skip, Flow Details on the Flows tab displays the list of skipped over-
lays.
Firewall Zone Policies
Use this dialog box to enable and associate firewall zones to your segments. With segmenta-
tion enabled, firewall zone security policies are orchestrated and there is no need for Firewall
Security Templates. After migration, deactivate the Security Policies Template in all Template
Groups. If left active, the template will override any default-default segment security policies
configured on this dialog box.
Before you begin Firewall Zone configuration, note the following:
Complete the following steps to set a rule or policy to your firewall zones within your seg-
ment.
1. Select the cell of the segment you want to update in the Matrix View. The From Zone To
Zone dialog box opens.
NOTE: If you are already in Table View, click Add Rule.
2. Enter the Source Segment in the Source Segment field. This is the segment that the
firewall is starting from.
3. Enter the Destination Segment in the Destination Segment field. This is the segment
where the firewall is going to.
4. Select Add Rule.
5. Complete the content in the table.
Field Description
6. Click Save. The Save Segment Firewall Zone Policies dialog box opens.
7. Enter a comment (optional) in the Audit Log Comment field, and then click Save. Any
text entered in the Audit Log Comment field appears on the Audit Logs tab.
NOTE: Firewall zones are unique to each segment. For example, the default zone in Segment
X will not be the same default zone in Segment Y.
Inter-Segment Routing & DNAT Exceptions
Use this tab to configure inter-segment routing and DNAT rules when traffic is crossing be-
tween segments.
Starting with Orchestrator release 9.5.1, you can configure rules that allow multiple source
segments to connect to one subnet destination. This configuration will form a group of rules.
Source segments connected to the same subnet destination must be grouped in one rule. For
example, if you select both “Guest” and “IoT” as the Source Segment for a subnet destination,
you cannot add another rule that contains either “Guest” or “IoT” for that same destination.
Field Description
Source Segment Name of the segment that traffic is initiating from. You can
select multiple source segments to create a group of rules.
Field Description
Add a Rule
1. Click the +Add link under the Inter-Segment Routing & DNAT column to open the Inter-
Segment Routing & DNAT dialog box.
2. Click +Add Rule to add a new rule.
NOTE: To edit a rule that is part of a group of rules, you must delete the existing rule
from the grouped rule by clearing the segment from the Source Segment list. Click in
the Source Segment cell to display the multi-selector, as shown in the following screen
capture.
3. Click in any cell to provide the details for the new rule (see field descriptions above).
4. Click Save to create the new rule or click Cancel to close the dialog box without making
any changes.
NOTE: Inter-segment routing & DNAT rules are orchestrated globally to all appliances from
this tab. To review rules on individual appliances, click Inter-Segment Routing & DNAT Ex-
ceptions and select the appliance in the tree. It is best practice to use only the globally or-
chestrated rules and avoid using local exceptions per appliance.
Delete a Rule
1. Click the corresponding delete icon (X). If the rule is a grouped rule, each rule that con-
tains the same source segment will be deleted also. Deleting one rule, could result in
multiple rules being deleted.
2. Click Save.
Field Description
Loopback
Click +Add and you are redirected to the Loopback Orchestration tab. Select the segment
you want to apply a loopback interface from the table, and then click +Add Loopback Inter-
face.
Appliances
This column represents the amount of appliances the selected segment is enabled on.
Comment
Click the cell in the Comment column to add a comment including any additional information
for that particular segment.
Delete a Segment
WARNING: Segmentation involves drastic changes to your physical network. Deleting seg-
ments can be service affecting. Carefully read this section before deleting any of your seg-
ments.
Deleting a segment removes all the segmentation configuration from all the appliances within
your network. When you delete a segment, Orchestrator automatically deletes the follow-
ing:
To delete a segment, click the X in the last column in the table. A Delete Routing Segment
warning appears. Click Delete or Cancel.
Disable a Segment
To disable routing segmentation across your network, you need to delete all configured seg-
ments in the network, except the default segment (which cannot be deleted). After all the
segments are deleted, navigate to this tab and move the toggle at the top of the page to dis-
able.
Management Services
Configuration > Networking > Routing > Management Services
Use this tab to configure management services. You can configure them regardless of whether
routing segmentation is enabled or disabled.
• When enabled, management services are functional in the associated segment based on
the selected interface.
• When disabled, all the interfaces are available for configuration.
NOTE: Management services still function if routing segmentation is not enabled in Orches-
trator. In this case, you will be able to use the default configuration only; that is, any interface
with the Default segment.
Starting with version 9.0, Orchestrator provides two tabs from which you can configure man-
agement services:
• Management Routes – Use this tab to configure static routes for management services
traffic from an EdgeConnect appliance (egress traffic).
• Management Services – Use this tab to specify the source IP address of the interface used
for each management service.
While it is recommended that you now use the Management Services tab to configure services,
you can continue to use the Management Routes tab if you are not required to specify source
IP addresses for management services.
The Management Services tab displays the following fields:
Field Description
Click the edit icon associated with the management service you want to configure.
1. Click twice in the Interface for Source IP Address field associated with that service.
A drop-down list of all the interfaces configured for your appliance appears.
2. Select an interface.
The Source Segment field updates automatically with the associated segment.
3. Click Save.
If the Interface for Source IP Address field is set to any, there is no control over which source
IP address will be used for management services egress packets. Depending on the route
lookup, the corresponding source IP configured in the Management Routes table is used as
the source IP of the packet. If the Source IP is not configured (0.0.0.0) in the Management
Routes table for the selected route, the egress interface’s IP address is used as the source IP
address.
Descriptions of management service behaviors follow:
Service Behavior
HTTP(S), Cloud Portal, and These services use the selected interface’s
Orchestrator Interface for Source IP Address as the source
address to establish reachability and WebSocket
connections to the Cloud Portal and Orchestrator.
HTTP/HTTPS uses the Interface for Source IP
Address for connection as well.
DHCP Relay, NTP, Other VRF mgmt Each of these management services use Interface
Apps, NetFlow, RADIUS/TACACS+, for Source IP Address as the source IP address.
SNMP, SSH, and Syslog The source interface configured from the
management route table is ignored if the
Interface for Source IP Address is not “any”.
Field Description
Source Segment Name of the segment that traffic is initiating from. You can
select multiple source segments to create a group of rules.
Matches Destination IP IP address that matches the destination segment IP address,
before DNAT. The IP address is included in the defined policy
match criteria.
Field Description
Send to Segment Name of the segment the packets are translated to from the
matched destination IP address. This is included in the set
criteria. Click in the cell to display the multi-selector, and then
select or clear segments.
Translated Destination IP IP address of the DNAT IP address when the segment is
translated.
Add a Rule
1. Click the edit icon to open the Inter-Segment Routing & DNAT dialog box.
2. Click +Add Rule to add a row to the table.
NOTE: To edit a rule that is part of a group of rules, you must delete the existing rule
from the grouped rule by clearing the segment from the Source Segment list. Click in
the Source Segment cell to display the multi-selector, as shown in the following screen
capture.
3. Click in any cell to provide the details for the new rule (see field descriptions above).
4. Click Save to create the new rule or click Cancel to close the dialog box without making
any changes.
NOTE: Inter-segment routing & DNAT rules are orchestrated globally to all appliances from
this tab. To review rules on individual appliances, click Inter-Segment Routing & DNAT Ex-
ceptions and select the appliance in the tree. It is best practice to use only the globally or-
chestrated rules and avoid using local exceptions per appliance.
Delete a Rule
1. Click the corresponding delete icon (X). If the rule is a grouped rule, each rule that con-
tains the same source segment will be deleted also. Deleting one rule, could result in
multiple rules being deleted.
2. Click Save.
Field Description
Appliance Name of the segment that the SNAT exception is being applied to.
Source Name of the segment that the SNAT is starting from.
Destination Name of the segment that the SNAT is translated to and going to.
SNAT Indicates whether SNAT is enabled or disabled for the specified
segment.
Comment Any additional information.
BGP Tab
Configuration > Networking > Routing > BGP
On this tab, you can configure BGP (Border Gateway Protocol) for appliances and add their
BGP peers (also known as BGP “neighbors”). You can also add and modify peer-based adver-
tisement and redistribution rules. EdgeConnect has the following behaviors relative to com-
munities:
• EdgeConnect will propagate any existing communities and can be configured to assign
and append new communities, remove, or replace all communities for routes advertised
to peers.
• Appliances can display up to ten communities per route.
• Appliances subnet-share communities with their EdgeConnect peers.
• Appliances advertise communities to remote peers, if learned from EdgeConnect peers.
• Appliances advertise communities to BGP neighbors.
• All BGP-learned subnets also appear in the appliance Routes table, displayed on the
Routes configuration page. In addition, any AS Path or BGP Community information
learned with a particular subnet will also be displayed with that subnet entry in the table.
• BGP route updates are not refreshed unless the peer specifically asks for it. To update
the BGP routes, go to the Peers table and select Soft Reset in the desired row.
• BGP Equal-cost multi-path (ECMP) is supported for eBGP and iBGP. Multiple next-hops
will be installed for the same prefix if all BGP path attributes are the same, enabling BGP
to load balance egress traffic across multiple peers.
• A maximum of 64 BGP peers and 64 OSPF neighbors is supported per appliance, with
200 next-hops supported per interface.
• A small set of community numbers are used as internal communities that represent the
source domain of a particular route:
Value Description
These internal community values only use the appliance’s local ASN in the ASN portion
of the community. When the ASN portion of an attached community exactly matches
the local ASN and the community portion exactly matches one of these internal values,
they are flagged as internal communities only and stripped when advertising the route
to BGP peers.
Click the Summary button on the BGP tab to display configuration details associated with the
local appliance, such as its local AS number and router ID. Click the icon in the BGP State
Details column to display a summary, including the number of routes learned and advertised
via BGP by this appliance.
Click the Peers button on the BGP tab to display information about all configured peers for the
appliances selected in the appliance tree. Click the icon in the Peer Details column to display
the connection status of each peer that is configured for the appliance.
Filter by Segment
To filter the rows displayed in the BGP table by segment:
• Select Default from the Segment drop-down list to display for the system-supplied de-
fault segment, or
• Select one of the other listed segments, which reflect the custom segments defined using
Routing Segmentation (Configuration > Networking > Routing > Routing Segmentation
(VRF)).
Select All to display for all segments, which is the default setting.
The table below describes the fields displayed for the BGP configuration.
Field Description
NOTE: When using VXLAN with BGP, only IPv4 addresses are
supported.
Local Interface A list of the interfaces that can be chosen: Any, lan0, wan0, or
wan1.
Peer ASN Peer’s Autonomous System Number.
Peer State State of the peer. A peer state of Established indicates that full
adjacency has been established and routes can be advertised to
and learned from that peer.
Soft Reset Click the Soft Reset button to manually request a route update
from the BGP peer without resetting the session.
Field Description
MED Multi Exit Discriminator. When BGP chooses the best route to reach
a certain destination, it first looks at the local preference and AS
path attributes. When the local preference and AS path length are
the same for two or more routes towards a certain prefix, the
Multi Exit Discriminator (MED) attribute is chosen. With MED, the
lowest value is preferred.
To edit the BGP configuration for one of the listed appliances, click the edit icon in the left
column of the table.
BGP Information
Use this window to enable BGP for your appliances and to configure BGP peers. Complete the
following steps to start BGP configuration.
Field Description
Autonomous system number Configure this number as needed for your network.
(ASN)
Router ID This router identifier is the IPv4 address by which the
remote peer can identify this appliance for purposes of
BGP.
Route Target The BGP route target that identifies the routes associated
with a segment. The route target must be in the following
form: 2bytesASN:4bytesID or 4byteASN:2byteID (for
example, 65001:1200).
3. Under the Common settings for all segments header, complete the following fields:
Field Description
Max route updates per peer The maximum number of route updates for each peer
running route loop detection. The default value is 10, and
the range is 5–100.
Detection interval The interval, in minutes, at which route advertisement loop
detection runs. A route advertisement loop occurs when
the same route is being advertised, removed, and
re-advertised repeatedly within a short time period. The
default value is 15, and the range is 1–60.
To add a BGP peer, select Add. The Add Peer dialog box opens.
Add Peer
Complete the following fields to add a BGP peer.
Field Description
Peer IP IP address of the EdgeConnect peer. IPv4 and IPv6 are both
supported.
Peer Adjacency To specify the adjacency of the BGP peer, click Single-Hop or
Multi-Hop. Single-Hop is the default selection.
EVPN Peer Select this check box to enable the extended BGP technology for
casting VXLAN information. Enabling EVPN Peer disables IPv4/IPv6
unicast routing for this peer. Only one address family is supported
per BGP peer. Only IPv4 is available when you enable VXLAN.
NOTE: EVPN Peer is only displayed for the default segment (VRF ID
= 0).
NOTE: This field is only available if you configured VXLAN using the
VXLAN template or by configuring it on the VXLAN tab and you
selected a VXLAN tunnel endpoint (VTEP) source interface. For
more information on configuring VXLAN and a VTEP source
interface, see VXLAN Tab or VXLAN Template.
Local Interface You can specify the source address or interface for a specific BGP
peer. Select the interface from the drop-down list: any, lan0,
wan0, or wan1. If you selected the EVPN Peer check box, this
value is automatically set to the VTEP source interface you set
when you configured VXLAN.
Peer ASN Replace all ASNs in the AS-Path of routes advertised to this peer
with the appliance ASN.
Field Description
Override ASN Select this check box to advertise routes to the BGP peer where
the BGP peer’s own ASN is in the AS-Path. All instances of the BGP
peer ASN are replaced with the local ASN of the appliance in all
routes advertised to the BGP peer.
Peer Type Select the type of peer from the drop-down list: Branch or
PE-router. If you selected the EVPN Peer check box, this value is
automatically set to Branch.
Admin Status Select whether you want the Admin Status UP or DOWN.
Soft Reconfiguration Select this check box to prevent the appliance from sending a
route-refresh message to the BGP peer when a policy is changed.
When enabled, the appliance will apply policy changes against BGP
peer learned routes stored in memory.
NOTE: To request a route update from the peer, click the Soft
Reset button for the peer on the BGP tab. Before you perform a
soft reset, ensure that Soft Reconfiguration is disabled for this BGP
peer.
Next-Hop-Self Select this check box to enable the next-hop-self.
Inbound route map Route map for inbound traffic. Select the edit icon to load or
configure inbound route maps.
Outbound route map Route map for outbound traffic. Select the edit icon to load or
configure outbound route maps.
Outbound route map Route map for outbound traffic. Select the edit icon to load or
configure outbound route maps.
BFD Select this check box to enable BFD for the BGP peer. This field is
not displayed if BFD is not supported on the appliance.
NOTE: Before you select this check box, enable and configure
BFD from the BFD tab.
Keep Alive Timer Interval, in seconds, between keep alive signals to a peer.
Hold Timer Specified time to wait before dropping the session when the
reachability to a peer is lost.
Enable MD5 Select this check box to add a password to authenticate the TCP
Password session with the peer.
NOTE: Multiple address families are not supported on a single BGP peer. You must configure
a separate BGP peer for each address family. IPv6 peers are only capable of exchanging IPv6
routes. IPv4 peers are only capable of exchanging IPv4 routes.
GE Clause
If a GE clause is applied, the rule will also include all prefixes that have a prefix length greater
than or equal to the GE value and less than or equal to 32 or 128 (for IPv6).
Example: A.B.C.D/X GE Y
In this example the following will be included:
For example, you have a route map entry of 192.168.0.0/16 GE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is not greater than or equal to 24. This route
does not match.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. Therefore, this
route matches the condition.
192.168.2.0/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route matches the condition.
192.168.2.128/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route also matches the condition.
So, the routes that would be matched by the given route map entry are:
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
LE Clause
If an LE clause is applied, the rule will also include all prefixes that have a prefix length less
than or equal to the LE value.
Example: A.B.C.D/X LE Y
In this example the following will be included:
For example, you have a route map entry of 192.168.0.0/16 LE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is less than or equal to 24. This route matches.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. This route
matches.
192.168.2.0/25 – The prefix length is 25, which is not less than or equal to 24. This route does
not match.
192.168.2.128/25 – The prefix length is 25, which is not less than or equal to 24. This route
does not match.
So, the routes that would be matched by the given route map entry are:
• 192.168.0.0/16
• 192.168.1.0/24
Example: A.B.C.D/X LE Y GE Z
In this example the following will be included:
Exact Match
If both GE and LE clauses are specified and are equal, the rule will result in an exact match.
Example: A.B.C.D/X LE Y GE Y
In this example, the following will be included:
You can specify the following fields in each rule for the selected route map.
Priority (Inbound and Outbound)
Field Description
Priority If you are using Orchestrator templates to add rules, Orchestrator will delete
all entries from 1000 – 9999 before applying its policies.
You can create rules with higher priority than Orchestrator rules (1 – 999) and
rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
When adding a rule, the priority is incremented by 10 from the previous rule.
The priority can be changed, but this default behavior helps to ensure you can
insert new rules without having to change subsequent priorities.
BGP Communities
BGP Communities
BGP Prefix + optional LE/GE parameters
BGP Communities
OSPF Prefix + optional LE/GE parameters
OSPF Tag
SD-WAN (BGP) Prefix + optional LE/GE parameters
BGP Communities
SD-WAN (OSPF) Prefix + optional LE/GE parameters
OSPF Tag
BGP Communities
SD-WAN (CFGSET) Prefix + optional LE/GE parameters
BGP Communities
SD-WAN (RIP) Prefix + optional LE/GE parameters
BGP Communities
SD-WAN (OVERLAY) Prefix + optional LE/GE parameters
BGP Communities
SD-WAN (IAPVPN) Prefix + optional LE/GE parameters
BGP Communities
OAP-BGP Prefix + optional LE/GE parameters
BGP Communities
OSPF Tag
OAP-CFGSET Prefix + optional LE/GE parameters
OAP-RIP Prefix + optional LE/GE parameters
OAP-OVERLAY Prefix + optional LE/GE parameters
OAP-IAPVPN Prefix + optional LE/GE parameters
OAP-STATIC Prefix + optional LE/GE parameters
OAP-DIRECT Prefix + optional LE/GE parameters
Field Description
Permit Enable or disable. This setting allows or denies the route map.
BGP Local Preference Best BGP destination. The default value is 100.
Metric Metric for the route.
BGP Communities Label of extra information that is added to one or more prefixes
advertised to BGP neighbors. There are three options for how this
information is added:
Field Description
The following table describes the redistribution commands supported in the BGP routing pro-
tocol.
• ASNs are applied only to new appliances. The ASNs configured in this dialog box do not
impact or change any previous or manually configured ASNs.
• ASN Range is configured for Default Segment and cannot be changed.
• ASN Orchestration assigns the same ASN to EdgeHA appliances.
• ASN Orchestration assigns the same ASN to appliances with same site name.
• If you use Orchestrator ASNs, do not use ASN 65534 and 1. These numbers are reserved.
Enter the start and end ranges for the ASNs. Click the +Add Reserved ASN to exclude any
ASNs from being applied to an appliance. You can reassign ASNs manually by using the BGP
tab.
Routes Tab
Configuration > Networking > Routing > Routes
Each appliance builds a route table with entries that are added automatically by the system,
added manually by a user, or learned from a routing protocol (SD-WAN Fabric Subnet Sharing,
BGP, or OSPF). On this tab, you can view all routes for all appliances.
You can filter the type of routes displayed by clicking All, Local / Static, SD-WAN Fabric, BGP,
OSPF, or OAP.
On this tab there are also links to the following tabs: BGP, OSPF, BFD, Peer Priority, Admin
Distance, and Multicast. Clicking Enable Subnet Sharing with System Templates opens the
Templates tab and launches the Add/Edit Template dialog box.
Route Maps
Route Maps are policies applied to IP routes during redistribution between routing protocols.
They have Match Criteria and Set Actions that allow for filtering routes or modifying metrics
and attributes for routes that meet the criteria defined in the match statement. Route-map
rules follow a top-down order based on the sequence number defined for each entry.
EdgeConnect Enterprise supports applying Route Maps inbound from and outbound to BGP
peers and outbound to OSPF neighbors and the SD-WAN Fabric. It is best practice to use
Orchestrator to apply Route Maps using templates.
Route mapping is supported for the following protocols and the direction of those protocols:
The following table lists the routing protocols and the associated commands supported.
SD-
Command Redistribution Support BGP OSPF WAN Local/Static
You can specify up to 20 route maps per protocol per direction, 128 rules per route map, and
six prefixes per rule. A route map without any enabled rules is treated as a default deny all.
Additionally, if a route map is not selected for BGP, OSPF, or SD-WAN redistribution points
this is also considered a deny all. To advertise routes via one of the protocol intersections you
must select a route map.
Import
Click Import to import route details from a CSV file into the selected appliance. Each row in the
CSV file should contain values for the following fields in the exact order specified with commas
to separate values:
• Subnet
• Mask Length
• Metric
• Is Local (no longer used; leave this value blank)
• Advertise to Silver Peak Peers (no longer used; leave this value blank)
• Advertise to BGP Peers (no longer used; leave this value blank)
• Next Hop
• Advertise to OSPF Neighbors (no longer used; leave this value blank)
• Interface Name
• Segment
• Zone
NOTE: Do not include a header row in the CSV file. Also, do not add spaces after commas in
rows.
The following lines illustrate what two rows in a CSV import file might look like:
10.1.0.0,16,50,,,,10.1.0.1,,lan0,Default
10.2.0.0,16,50,,,,,,,
Export
Click Export to save the contents of the Routes table to a CSV file.
Filter by Subnet
To filter the routes displayed in the Routes table by subnet, enter the subnet in the Filter by
subnet field, and then click Apply.
Filter by Segment
To filter the routes displayed in the Routes table by segment:
• Select Default from the Segment drop-down list to display for the system-supplied de-
fault segment, or
• Select one of the other listed segments, which reflect the custom segments defined using
Routing Segmentation (Configuration > Networking > Routing > Routing Segmentation
(VRF)).
Select All to display for all segments, which is the default setting.
A Very Large Query Response pop-up will display if the number of the routes filtered exceeds
500,000. You can filter by subnet and/or segment, or you can cancel or continue waiting to
help mitigate this issue.
NOTE: If the number of the routes filtered is greater than 500,000 the following pop-up will
display.
Segment
The segments you have configured on the Routing Segmentation tab are listed in the Segment
field. After you specify the segment, the Routes table displays only the routes belonging to that
segment.
The following information is displayed for each route listed in the table:
Field Description
Field Description
<BGP peer Type>: <BGP peer ip> – Subnets added by exchanging information
with local BGP peers.
<BGP peer Type> EVPN: <BGP peer ip> – Subnets added by exchanging
information with local EVPN enabled BGP peers.
Field Description
NOTE: If the route is a BGP route and EVPN is enabled for the route, only the
import route target (labeled “Route Target”) is displayed. The export route
target is not displayed.
Comment Any additional information you would like to include.
If there are two or more routes that match all the above criteria, use multiple routes.
Admin Distance Configuration
You can configure the admin distance by using the Admin Distance template on the Templates
tab. The default settings in this template determine the most reliable route with the use of
admin distance. See the table below for the various default admin distances per route type.
Local 1
Subnet Shared - Static Routes 10
Subnet Shared - BGP Remote 15
Subnet Shared CFGSET 15
Subnet Shared IAPVPN 15
Subnet Shared - OSPF Remote 15
Subnet Shared Overlay 15
Subnet Shared RIP 15
eBGP 20
OAP BGP 25
OAP CFGSET 25
OAP Direct 25
OAP IAPVPN 25
OAP OSPF 25
OAP Overlay 25
OAP RIP 25
OAP Static 25
OSPF 110
iBGP 200
Navigate to the BGP and OSPF tabs for more information about applying or configuring your
route maps.
Field Description
Automatically advertise local LAN subnets Indicates whether the system-created LAN
subnets of your appliance should be
advertised to your peers.
Automatically advertise local WAN subnets Indicates whether the system-created local
WAN subnets of your appliance should be
advertised to your peers.
Field Description
Local/Static
SD-WAN (Local/Static)
SD-WAN (BGP)
SD-WAN (OSPF)
Field Description
Enable Equal Cost Multi Path (ECMP) Indicates whether you want to enable Equal
Cost Multi-Path routing support.
Add Routes
Use the Add Routes dialog box to add a user-defined route to an appliance’s route table.
Field Description
3. Click Add.
Import Subnets
Do the following to import route details from a CSV file into the selected appliance.
GE Clause
If a GE clause is applied, the rule will also include all prefixes that have a prefix length greater
than or equal to the GE value and less than or equal to 32 or 128 (for IPv6).
Example: A.B.C.D/X GE Y
In this example the following will be included:
• All the prefixes that belong to the subnet A.B.C.D/X that have a length greater than or
equal to Y and less than or equal to 32
For example, you have a route map entry of 192.168.0.0/16 GE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is not greater than or equal to 24. This route
does not match.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. Therefore, this
route matches the condition.
192.168.2.0/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route matches the condition.
192.168.2.128/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route also matches the condition.
So, the routes that would be matched by the given route map entry are:
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
LE Clause
If an LE clause is applied, the rule will also include all prefixes that have a prefix length less
than or equal to the LE value.
Example: A.B.C.D/X LE Y
In this example the following will be included:
For example, you have a route map entry of 192.168.0.0/16 LE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is less than or equal to 24. This route matches.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. This route
matches.
192.168.2.0/25 – The prefix length is 25, which is not less than or equal to 24. This route does
not match.
192.168.2.128/25 – The prefix length is 25, which is not less than or equal to 24. This route
does not match.
So, the routes that would be matched by the given route map entry are:
• 192.168.0.0/16
• 192.168.1.0/24
Example: A.B.C.D/X LE Y GE Z
In this example the following will be included:
Exact Match
If both GE and LE clauses are specified and are equal, the rule will result in an exact match.
Example: A.B.C.D/X LE Y GE Y
In this example, the following will be included:
You can specify the following fields in each rule for the selected route map.
Priority
Field Description
Priority If you are using Orchestrator templates to add rules, Orchestrator will delete
all entries from 1000 – 9999 before applying its policies.
You can create rules with higher priority than Orchestrator rules (1 – 999) and
rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
When adding a rule, the priority is incremented by 10 from the previous rule.
The priority can be changed, but this default behavior helps to ensure you can
insert new rules without having to change subsequent priorities.
BGP Communities
OSPF Prefix + optional LE/GE parameters
OSPF Tag
ANY Prefix + optional LE/GE parameters
OSPF Tag
BGP Communities
OAP-BGP Prefix + optional LE/GE parameters
BGP Communities
OAP-OSPF Prefix + optional LE/GE parameters
OSPF Tag
OAP-CFGSET Prefix + optional LE/GE parameters
OAP-RIP Prefix + optional LE/GE parameters
OAP-OVERLAY Prefix + optional LE/GE parameters
OAP-IAPVPN Prefix + optional LE/GE parameters
OAP-STATIC Prefix + optional LE/GE parameters
OAP-DIRECT Prefix + optional LE/GE parameters
NOTE: The above fields in the right column will change depending on the source protocol
chosen.
Set Actions
Field Description
Permit Enable or disable. This setting allows or denies the route map.
OSPF Tag Value of OSPF tag to set in routing information sent to destination.
NOTE: This field is displayed only if Source Protocol is set to OSPF or OAP
OSPF.
Metric Metric for the route.
Comment Comment you want to include.
OSPF Tab
Configuration > Networking > Routing > OSPF
This tab manages OSPF (Open Shortest Path First) on LAN and WAN interfaces.
OSPF learns routes from routing peers, and then subnet shares them with EdgeConnect peers
and/or BGP neighbors.
A route tag is applied to a route to better identify the source of the network it originated from.
It is primarily used to filter routes from being redistributed in a routing loop.
A maximum of 64 OSPF neighbors and 64 BGP peers is supported per appliance, with 200
next-hops supported per interface.
• For BGP, only 64 peers can be added. For OSPF, more than 64 neighbors can be added,
though an error will be logged.
• If more than 64 OSPF neighbors are added, the active OSPF neighbors are chosen in a
deterministic manner. All OSPF neighbors that are added are queried in a sorted order
using segment ID as the primary index and the neighbor IP address as the secondary
index. For example, if there are 65 OSPF neighbors, the peer in the highest segment
and with the highest IP address will be the one that is always dropped. It will not drop a
random OSPF neighbor.
• Also, if there are 60 OSPF neighbors in the default segment, which always has ID:0, and
10 OSPF neighbors in segment 1, the 60 neighbors in the default segment will always be
included, as well as the 4 neighbors in segment 1 with the lowest IP addresses.
Filter by Segment
To filter the rows displayed in the OSPF table by segment:
• Select Default from the Segment drop-down list to display for the system-supplied de-
fault segment, or
• Select one of the other listed segments, which reflect the custom segments defined using
Routing Segmentation (Configuration > Networking > Routing > Routing Segmentation
(VRF)).
Select All to display for all segments, which is the default setting
The table below describes the fields displayed for the OSPF configuration.
Field Description
Select the edit icon in the OSPF table to edit and enable OSPF.
Field Description
Enable OSPF When enabled, the appliance has access to use the OSPF
protocol.
Router ID IPv4 address of the router that the remote peer uses to
identify the appliance for purposes of OSPF.
Redistribute routes to OSPF Redistributing routes into OSPF from other routing protocols
or from static will cause these routes to become OSPF
external routes. Select the edit icon to the left of this field
and select the OSPF route redistribution maps you would like
to select.
Opaque LSA support Enable for acknowledgment of opaque LSAs through OSPF
protocol.
To add an additional interface to an OSPF route, click Add in the Interfaces section.
NOTE: The BFD field in the Interfaces table on the OSPF dialog box is set to N/A if BFD is not
supported on the appliance.
To configure or modify an OSPF route map, select the edit icon next to the Redistribute routes
to OSPF field.
Add Interface
Complete the following fields to add an interface to OSPF.
Field Description
NOTE: Before you select this check box, enable and configure
BFD from the BFD tab.
Field Description
GE Clause
If a GE clause is applied, the rule will also include all prefixes that have a prefix length greater
than or equal to the GE value and less than or equal to 32 or 128 (for IPv6).
Example: A.B.C.D/X GE Y
For example, you have a route map entry of 192.168.0.0/16 GE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is not greater than or equal to 24. This route
does not match.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. Therefore, this
route matches the condition.
192.168.2.0/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route matches the condition.
192.168.2.128/25 – The prefix length is 25, which is greater than or equal to 24. Therefore, this
route also matches the condition.
So, the routes that would be matched by the given route map entry are:
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
LE Clause
If an LE clause is applied, the rule will also include all prefixes that have a prefix length less
than or equal to the LE value.
Example: A.B.C.D/X LE Y
In this example the following will be included:
For example, you have a route map entry of 192.168.0.0/16 LE 24, and a peer advertises the
following prefixes:
• 192.168.0.0/16
• 192.168.1.0/24
• 192.168.2.0/25
• 192.168.2.128/25
192.168.0.0/16 – The prefix length is 16, which is less than or equal to 24. This route matches.
192.168.1.0/24 – The prefix length is 24, which is equal to the specified value. This route
matches.
192.168.2.0/25 – The prefix length is 25, which is not less than or equal to 24. This route does
not match.
192.168.2.128/25 – The prefix length is 25, which is not less than or equal to 24. This route
does not match.
So, the routes that would be matched by the given route map entry are:
• 192.168.0.0/16
• 192.168.1.0/24
Example: A.B.C.D/X LE Y GE Z
In this example the following will be included:
Exact Match
If both GE and LE clauses are specified and are equal, the rule will result in an exact match.
Example: A.B.C.D/X LE Y GE Y
In this example, the following will be included:
You can specify the following fields in each rule for the selected route map.
Priority
Field Description
Priority If you are using Orchestrator templates to add rules, Orchestrator will delete
all entries from 1000 – 9999 before applying its policies.
You can create rules with higher priority than Orchestrator rules (1 – 999) and
rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
When adding a rule, the priority is incremented by 10 from the previous rule.
The priority can be changed, but this default behavior helps to ensure you can
insert new rules without having to change subsequent priorities.
BGP Communities
SD-WAN Routes Prefix + optional LE/GE parameters
BGP Communities
OSPF Tag
OAP-BGP Prefix + optional LE/GE parameters
BGP Communities
OAP-OSPF Prefix + optional LE/GE parameters
OSPF Tag
OAP-CFGSET Prefix + optional LE/GE parameters
OAP-RIP Prefix + optional LE/GE parameters
OAP-OVERLAY Prefix + optional LE/GE parameters
OAP-IAPVPN Prefix + optional LE/GE parameters
OAP-STATIC Prefix + optional LE/GE parameters
OAP-DIRECT Prefix + optional LE/GE parameters
NOTE: The above fields in the right column will change depending on the source protocol
chosen.
Set Actions
Field Description
Permit Enable or disable. This setting allows or denies the route map.
OSPF Tag Value of OSPF tag to set in routing information sent to destination.
OSPF Metric Type Filters redistributed routes to OSPF.
Metric Metric for the route.
Comment Comment you want to include.
BFD Tab
Configuration > Networking > Routing > BFD
Bidirectional Forwarding Detection (BFD) is a networking protocol that detects faults between
devices. The EdgeConnect appliance supports BFD for both BGP and OSPF.
• Single and multi-hop BFD configurations are supported.
• BFD asynchronous mode is supported.
• BFD can be configured for up to 20 segments with a maximum of 100 simultaneous BFD
sessions across all segments.
Configuring BFD for BGP or OSPF is a two-step process:
1. Click the edit icon for an appliance listed in the BFD table on the BFD tab, and then enable
and configure BFD on the BFD dialog box. For details, see BFD Dialog Box.
2. Enable BFD for each BGP peer or OSPF interface.
1. For BGP, navigate to Configuration > Networking > Routing > BGP. Click the edit
icon for an appliance listed in the BGP table, and then click Add to add a BGP peer
or click the edit icon for an existing BGP peer listed in the BGP Peers table. Select
the BFD check box, make other changes as appropriate, and then click Add or Save.
2. For OSPF, navigate to Configuration > Networking > Routing > OSPF. Click the edit
icon for an appliance listed in the OSPF table, and then click Add in the Interfaces
area to add an interface or click the edit icon for an existing interface listed in the
Interfaces table. Select the BFD check box, make other changes as appropriate, and
then click Add or Save.
The BFD tab provides two views of BFD information:
• Click the Summary button on the BFD tab to display configuration details associated
with the local appliance. For field descriptions, see BFD Dialog Box.
• Click the Sessions button to display currently active BFD sessions. BFD establishes a ses-
sion between two endpoints over a particular link. If more than one link exists between
two systems, multiple BFD sessions can be established to monitor each of them.
Filter by Segment
To filter the rows displayed in the BFD table by segment:
• Select Default from the Segment drop-down list to display for the system-supplied de-
fault segment, or
• Select one of the other listed segments, which reflect the custom segments defined using
Routing Segmentation (Configuration > Networking > Routing > Routing Segmentation
(VRF)).
Select All to display for all segments, which is the default setting.
The following table describes the fields displayed in the Sessions view of the BFD tab.
Field Description
Field Description
Multicast
Configuration > Networking > Routing > Multicast
Orchestrator supports multicast routing, a method of sending data from a single IP address
to a larger group of recipients.
Orchestrator provides four views of multicast status, each accessible by one of the correspond-
ing buttons at the top of the Multicast tab: Summary, Interfaces, Neighbors, and Routes.
Descriptions of fields on the Summary view follow:
Field Description
Appliance Name of the appliance (also selected in the left menu) associated
with the multicast configuration.
Enable Indicates whether multicast is enabled.
Rendezvous Point IP IP address of the centralized, source router distributing the packet
of traffic to each router involved in multicast.
Allowed Group Only IP addresses included in the specified address group can
multicast. If no address group is specified, any IP address can
multicast. The message Feature is not supported for the appliance
displays in this field if the appliance does not support the Allowed
Group feature.
Click the edit icon to enable or disable multicast, add an interface for multicast, or edit an
existing interface.
1. Click the edit icon next to the appliance for which you want to set up multicast.
The Multicast dialog box opens.
2. Move the Enable Multicast toggle to the right to enable multicast.
3. In the Rendezvous Point IP Address field, enter the appropriate IP address.
4. In the Allowed Group field, select an available address group from the drop-down list
or enter a new address group. All IP addresses included in the specified address group
will be allowed to multicast. This field is not displayed if the appliance does not support
the Allowed Group feature. Address group names can include letters, numbers, periods,
underscores, or hyphens.
IMPORTANT: The address group you specify in the Address Group field must be valid. If you
enter a new address group, ensure that you also create and set it up on the Address Groups
tab (Configuration > Templates & Policies > ACLs > Address Groups). If the new address group
remains invalid, no IP addresses will be allowed to multicast.
Interfaces
Field Description
To add an interface:
1. Click Add.
The Add Interface dialog box opens.
2. Select the desired interface from the Interface drop-down list.
3. Select the Enable PIM check box if you want to enable it.
4. Select the Enable IGMP check box if you want to enable it.
5. Click Add.
Neighbors
Field Description
Routes
Field Description
On the Multicast tab, you can click Export CSV to export a spreadsheet of the multicast report.
You can also click the refresh button to update information displayed on the tab.
• If a Peer Priority is not configured, the appliance randomly distributes flows among
multiple peers.
• The lower the number, the higher the peer’s priority.
Click the edit icon to configure a peer and its peer priority.
• Peer priority controls the peer to which traffic is sent when route ties occur. It acts similar
to BGP’s local preference.
• Advertise metric controls the return path of a flow back toward the local appliance. It
adjusts the metric of all routes sent to Peer Name. Advertise metric announces different
metrics to different fabric peers. It acts similar to BGP’s Multi Exit Discriminator (MED).
The default setting is preserve existing (do nothing).
Both peer priority and advertise metric impact all routes sent and received from Peer Name.
To add a peer:
Field Description
Field Description
Subnet Shared CFGSET ORO (Overlay Route Orchestrator) BGW (branch gateway)
route learned from the SD-WAN fabric.
Subnet Shared RIP ORO learned Routing Information Protocol route learned
from the SD-WAN fabric.
Subnet Shared Overlay ORO modified/added route learned from the SD-WAN
fabric.
Subnet Shared IAPVPN ORO Instant Access Point route learned from the SD-WAN
fabric.
OAP BGP Route learned from an OAP (Overlay Route Orchestrator)
BGP peer in an external network.
OAP CFGSET BGW (branch gateway) route learned from ORO.
OAP Direct Direct (connected) route learned from ORO.
OAP IAPVPN Instant Access Point route learned from ORO.
OAP OSPF Route learned from an OAP OSPF neighbor.
OAP Overlay ORO modified/added route.
OAP RIP Routing Information Protocol route learned from ORO.
OAP Static Static route learned from ORO.
• Management routes specify the default gateways and local IP subnets for the manage-
ment interfaces.
• In a Dual-Homed Router Mode configuration, you might need to add a static manage-
ment route for flow redirection between appliances paired for redundancy at the same
site.
• The management routes table shows the configured static routes and any dynamically
created routes. If you use DHCP, the appliance automatically creates appropriate dy-
namic routes. A user cannot delete or add dynamic routes.
• If the Source IP is listed as 0.0.0.0, packets sent using this route use the Interface’s IP
address as the Source IP address. If the Source IP lists a specific IP address, that IP
address is used instead.
VXLAN Tab
Configuration > Networking > Routing > VXLAN
Use the VXLAN tab to specify Virtual Extensible Local Area Network (VXLAN) and Virtual Net-
work Identifier (VNI) settings for routing segments already configured on HPE Aruba Network-
ing CX switches or EdgeConnect appliances. VXLAN allows you to create multiple Layer 2 seg-
ments over a Layer 3 network. Each segment is identified by a 24-bit VNI that can support up
to 16 million virtual networks.
VXLAN encapsulates Layer 2 Ethernet frames in Layer 3 UDP packets, enabling you to create
virtualized Layer 2 subnets, or segments, that span physical Layer 3 networks. The entity that
performs the encapsulation and decapsulation of packets is called a Virtual Tunnel Endpoint
(VTEP). An EdgeConnect is a VTEP for WAN-to-LAN traffic. An HPE Aruba Networking CX switch
is a VTEP for LAN-to-LAN traffic.
A VNI specifies a routing segment, a firewall zone, and a fallback role for a VXLAN instance. A
VNI identifies different virtual networks in the data plane. A VNI is a 24-bit value in the VXLAN
header and can support up to 16 million individual network segments. A VNI is like a VLAN ID
but has a larger address space. A VNI maps the virtual network to a specific VXLAN segment.
The VNI identifies the destination of the traffic in the VXLAN network. VNI is the basis for
isolating different virtual networks from each other.
Once a VNI is configured for a segment or in a template, HPE Aruba Networking CX switches
or EdgeConnect appliances automatically create a network virtual interface (NVE) as a VXLAN
tunnel endpoint (VTEP). A VTEP encapsulates and decapsulates VXLAN packets. The only ac-
cepted peer is the NVE that is configured in BGP. Packets received with a VNI not mapped to
a segment will be dropped.
EdgeConnect automatically binds the NVE to the VXLAN segment and specifies the source
interface for the VXLAN tunnel - only loopback interfaces from the default segment are valid.
If BGP EVPN Peer is enabled, the loopback interface you choose is automatically configured
in the local interface field of the BGP EVPN Peer configuration. For more information on BGP
EVPN Peer configuration, see the BGP tab.
The VXLAN packet tells BGP the target VTEP. BGP discovers the remote VXLAN tunnel endpoint
address, advertises routes that are reachable over this tunnel as the forwarding next hop, and
dynamically brings down this tunnel when reachability over the tunnel is no longer needed.
Prerequisites
Before you can assign a VNI to a VXLAN segment, you must configure the following settings:
• Segmentation must be enabled to support VXLAN. See the Routing Segmentation (VRF)
tab.
• The IP routing on the BGP Layer 3 network that connects the EdgeConnect VTEPs must
already be configured. This is necessary to enable VXLAN traffic to traverse the network.
Therefore, only in-line router mode is supported.
• Currently, the EdgeConnect EVPN address family is only supported for BGP EVPN peers
in the Default segment (VRF ID = 0).
• One or more loopback interfaces must already be available.
• VXLAN is only supported on LAN interfaces. Route-Targets must be defined, and BGP
enabled for all segments, even if no BGP peers are configured in non-default segments.
• Destination UDP Port: You can configure a custom destination UDP port for VXLAN. If
not selected, the appliance uses the default port of 4789.
• VTEP Source Interface: Select a loopback interface from the list.
NOTE: Only loopback interfaces are valid. The loopback interface you choose will auto-
matically be configured in the local interface field of the BGP Peer configuration if EVPN
Peer is enabled.
VNI Mappings
For this dialog box, use the steps below to map a VNI to a routing segment, a firewall zone,
and a fallback role.
NOTE: All configured VNIs configured on an EdgeConnect are communicated to a BGP peer in
a single VXLAN tunnel. While the VXLAN tab lists each VNI separately, it only reports the status
of that single VXLAN tunnel in the first VNI on the list. Conversely, the Routes tab displays the
routes for each VNI segment that is being communicated in the VXLAN tunnel.
Add
Edit
VTEP Details
The VTEP Details dialog box provides the following real-time statistics:
• VTEP Peer Details Transmit and receive packet counts, byte counts, and error counts
– IP address
– MAC address
– Status (UP/DOWN)
– Uptime
– Origin (DYNAMIC/STATIS)
– Associated routes (for all VNIs on the EdgeConnect)
– RX packets
– TX packets
– RX bytes
– TX Bytes
– RX drops
– TX drops
Tunnels Tab
Configuration > Networking > Tunnels > Tunnels
EdgeConnect tunnels are the foundation of your SD-WAN fabric. This tab displays details about
tunnels in your network. It includes the following four subtabs:
• HPE ANW Central – Displays tunnels orchestrated by HPE Aruba Networking Central.
In an SD-WAN network, Business Intent Overlays (BIOs) govern automatic tunnel creation and
properties. This tab also provides the means to manually create IP Sec tunnels either between
EdgeConnect appliances or from an EdgeConnect appliance to a third-party service.
NOTE: Manually created underlay tunnels cannot be used by BIOs.
Underlay Tunnel Naming
Underlay tunnels are uni-directional from the appliance listed in the Appliance column to the
appliance listed after “to_” in the Underlay Tunnel column. The Underlay Tunnel column also
includes the interface labels for the “from” and “to” sources.
Field Description
Field Description
down – Tunnel is down. This can occur because the Admin Status of
the tunnel is set to “down” (indicated when down status background
is orange) or the tunnel cannot communicate with the appliance at
the other end (indicated when down status background is red).
Possible causes are:
IPSec is misconfigured: (1) enabled on one side (see show int tunnel
configured), or mismatched pre-shared key.
up - idle – Tunnel is up and active, but it has not had activity during
the past five minutes, and it has slowed the rate of issuing
keep-alive packets.
Field Description
MTU Maximum Transmission Unit. The largest possible unit of data that
can be sent on a given physical medium. MTUs up to 9000 bytes are
supported. Auto allows the tunnel MTU to be discovered
automatically. It overrides the MTU setting.
Uptime Length of time the tunnel has been up.
Underlay Tunnels Designated underlay tunnels.
Live View Click the chart icon to display a live view of the status of your
selected tunnel. You can view by bandwidth, loss, jitter, latency,
MOS, chart, traceroute, inbound or outbound, and lock the scale.
Historical Charts Click the chart icon to display historical charts for the selected
overlay and underlay tunnels.
Underlay Subtab
Field Description
Field Description
down – Tunnel is down. This can occur because the Admin Status of
the tunnel is set to “down” (indicated when down status background
is orange) or the tunnel cannot communicate with the appliance at
the other end (indicated when down status background is red).
Possible causes are:
IPSec is misconfigured: (1) enabled on one side (see show int tunnel
configured), or mismatched pre-shared key.
up - idle – Tunnel is up and active, but it has not had activity during
the past five minutes, and it has slowed the rate of issuing
keep-alive packets.
Field Description
NOTE: If the NAT-related link under the Next Hop field on the WAN
side of the appliance deployment is set to “NAT” (see the figure
below), the appliance is behind a NAT-ed interface and the WAN
Public IP address is auto discovered from the Cloud Portal.
Discovered IP:Port Discovered IP address and port number, which represents the IP
address and port contained in the NAT Discovery (NAT-D) packet
sent at the beginning of tunnel setup. If this field displays
“NONE:NONE”, the local appliance has not received a NAT-D packet
from the remote appliance. This indicates connectivity issues
between the locations. If the local appliance receives NAT-D packets,
this field populates accordingly, and data path tunnel packets are
being received as well.
Passthrough Subtab
Field Description
Field Description
Troubleshooting
1. Have you created and applied the Overlay to all the appliances on which you are expecting
tunnels to be built?
Verify this on the Apply Overlays tab.
2. Are the appliances on which you are expecting the Overlays to be built using Release 8.0 or
later?
View the active software releases on Administration > Software > Upgrade > Software
Versions.
3. Do you have at least one WAN Label selected as a Primary port in the Overlay Policy?
Verify this on the Business Intent Overlay tab in the WAN Links & Bonding Policy section.
4. Are the same WAN labels selected in the Overlay assigned to the WAN interfaces on the appli-
ances?
Verify that at least one of the Primary Labels selected in the Business Intent Overlay is
identical to a Label assigned on the appliance’s Deployment page. Tunnels are built be-
tween matching Labels on all appliances participating in the overlay.
5. Do any two (or more) appliances have the same Site/Cluster Name?
We __*only__* assign the same Site/Cluster Name if we do not want those appliances to
connect directly. To view the list of Site/Cluster Names, navigate to the Configuration >
Networking > Tunnels > Tunnels tab, and then click Sites/Clusters at the top.
Field Description
NOTE: If using IKE-based IPSec with IKEv2 you can leave this
field set to Auto, otherwise it is recommended that you use the
AES_256_GCM_16 algorithm, which performs both encryption
and authentication, resulting in better performance.
IPSec Suite B Preset This field is available only if the Mode field is set to IPSec.
Select an IPSec Suite B preset if required by the security
service (GCM-128, GCM-256, GMAC-128, or GMAC-256). The
default setting is None.
Field Description
Packet
NOTE: FEC settings do not apply when overlays are used. FEC settings only apply when
routing directly to an underlay via Route Policy.
Field Description
Reorder wait Maximum time (in milliseconds) the appliance holds an out-of-order
packet when attempting to reorder. 100 ms is the default value and
should be adequate for most situations. FEC can introduce out-of-order
packets if the reorder wait time is not set high enough.
FEC Set Forward Error Correction (FEC) to enable, disable, or auto.
FEC ratio When FEC is set to auto, FEC will range dynamically from off to 1:10 based
on detected loss. The options are 1:1, 1:2, 1:5, 1:10, and 1:20. This field is
available only if FEC is set to enable.
Tunnel Health
Field Description
Retry count Number of failed keep-alive messages that are allowed before the
appliance raises a tunnel-down alarm. Default value is 30; maximum value
is 60.
DSCP Determines the DSCP marking that the keep-alive messages should use.
FastFail Thresholds
NOTE: FastFail thresholds were used in a legacy application and should be ignored.
Field Description
Fastfail enabled When multiple tunnels are carrying data between two
appliances, this feature determines how quickly to
disqualify a tunnel from carrying data.
Base = 200mSN = 2
Then,
RTTavg = 50mS
Field Description
Field Description
Peer There are two options for IKE authentication, End entity certificate or
authentication Pre-shared key, choose one of the options.
End entity certificate – If selected, select the certificate (label) from the
End entity certificate drop-down menu.
NOTE: To select an end entity certificate, you must first generate an end
entity certificate for use. To do this, see End Entity Certificates Tab. If
you have not generated any end entity certificates, the menu will be
empty.
NOTE: If you change the pre-shared key, record the new pre-shared key
you entered, as the pre-shared key configuration on both peers should
match.
Authentication Authentication algorithm used for IKE security association (SA). The
Algorithm default is SHA1. If the Encryption Algorithm field is set to AES-GCM-128
or AES-GCM-256, this field is not applicable.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select SHA1, SHA2-256, SHA2-384, or SHA2-512.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate algorithm.
NOTE: With IKEv2 and the Encryption algorithm field set to auto,
AES-GCM will probably be negotiated, which includes encryption and
authentication. In this case, this field might show a SHA setting that is
not actually used.
Field Description
Encryption Encryption algorithm used for IKE security association (SA). The
Algorithm recommendation is to select AES-GCM-256. This algorithm also includes
authentication (Authentication Algorithm will show as “NA”).
If the IPSec Suite B Preset field on the General tab is set to None, and
the IKE Version field is set to IKE v1, you can select AES-CBC-128,
AES-CBC-256, or auto. The default setting is auto.
If the IPSec Suite B Preset field on the General tab is set to None, and
the IKE Version field is set to IKE v2, you can select AES-CBC-128,
AES-CBC-256, AES-GCM-128, AES-GCM-256, or auto. The default setting
is auto.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate algorithm.
Pseudo Random This field is displayed only if the IKE Encryption Algorithm field is set to
Function AES-GCM-128 or AES-GCM-256.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select the appropriate group. Available groups are 14 through 21,
26, and 31.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate group.
Field Description
If the IKE Version field is set to IKE v1, you can select Main or
Aggressive.
If the IKE Version field is set to IKE v2, this field is automatically set to
Aggressive.
Field Description
IKE version If the IPSec Suite B Preset field on the General tab is set to None, you
can select IKE v1 or IKE v2. The recommendation is to select IKE v2.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to IKE v2.
Field Description
Authentication Authentication algorithm used for the IPSec security association (SA).
algorithm The default is SHA1. If the Encryption Algorithm field is set to
AES-GCM-128 or AES-GCM-256, this field is not applicable.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select SHA1, SHA2-256, SHA2-384, SHA2-512, AES-GMAC-128, or
AES-GMAC-256.
If the IPSec Suite B Preset field on the General tab is set to None, and the
IPSec Authentication algorithm field is set to SHA1, SHA2-256, SHA2-384,
or SHA2-512, you can select AES-CBC-128, AEC-CBC-256, AES-GCM-128,
AES-GCM-256, NULL, or Auto. The default setting is auto.
If the IPSec Suite B Preset field is set to None, and the IPSec
Authentication algorithm field is set to AES-GMAC-128 or
AES-GMAC-256, this field is automatically set to NULL.
IPSec anti-replay Select a size from the drop-down list or Disable to disable the IPSec
window anti-replay window.
Field Description
6. Click Save.
Field Description
Field Description
NOTE: If using IKE-based IPSec with IKEv2 you can leave this
field set to Auto, otherwise it is recommended that you use the
AES_256_GCM_16 algorithm, which performs both encryption
and authentication, resulting in better performance.
IPSec Suite B Preset This field is available only if the Mode field is set to IPSec.
Select an IPSec Suite B preset if required by the security
service (GCM-128, GCM-256, GMAC-128, or GMAC-256). The
default setting is None.
Field Description
Pre-shared key The pre-shared key used for IKE authentication. A default value of
“silverpeak” is pre-populated in the Pre-shared key field. It is
recommended to change the pre-shared key per the following
requirements: The pre-shared key must contain at least 8 characters,
and cannot contain [ ] { } ” # * characters. Max length is 64 characters.
NOTE: If you change the pre-shared key, record the new pre-shared key
you entered, as the pre-shared key configuration on both peers should
match.
Authentication Authentication algorithm used for IKE security association (SA). The
Algorithm default is SHA1. If the Encryption Algorithm field is set to AES-GCM-128
or AES-GCM-256, this field is not applicable.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select SHA1, SHA2-256, SHA2-384, or SHA2-512.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate algorithm.
NOTE: With IKEv2 and the Encryption algorithm field set to auto,
AES-GCM will probably be negotiated, which includes encryption and
authentication. In this case, this field might show a SHA setting that is
not actually used.
Encryption Encryption algorithm used for IKE security association (SA). The
Algorithm recommendation is to select AES-GCM-256. This algorithm also includes
authentication (Authentication Algorithm will show as “NA”).
If the IPSec Suite B Preset field on the General tab is set to None, and
the IKE Version field is set to IKE v1, you can select AES-CBC-128,
AES-CBC-256, or auto. The default setting is auto.
If the IPSec Suite B Preset field on the General tab is set to None, and
the IKE Version field is set to IKE v2, you can select AES-CBC-128,
AES-CBC-256, AES-GCM-128, AES-GCM-256, or auto. The default setting
is auto.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate algorithm.
Field Description
Pseudo Random This field is displayed only if the IKE Encryption Algorithm field is set to
Function AES-GCM-128 or AES-GCM-256.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select the appropriate group. Available groups are 14 through 21,
26, and 31.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to the appropriate group.
If the IKE Version field is set to IKE v1, you can select Main or
Aggressive.
If the IKE Version field is set to IKE v2, this field is automatically set to
Aggressive.
IKE version If the IPSec Suite B Preset field on the General tab is set to None, you
can select IKE v1 or IKE v2. The recommendation is to select IKE v2.
If the IPSec Suite B Preset field is set to any other setting, this field is
automatically set to IKE v2.
Field Description
Authentication Authentication algorithm used for the IPSec security association (SA).
algorithm The default is SHA1. If the Encryption Algorithm field is set to
AES-GCM-128 or AES-GCM-256, this field is not applicable.
If the IPSec Suite B Preset field on the General tab is set to None, you
can select SHA1, SHA2-256, SHA2-384, SHA2-512, AES-GMAC-128, or
AES-GMAC-256.
If the IPSec Suite B Preset field on the General tab is set to None, and the
IPSec Authentication algorithm field is set to SHA1, SHA2-256, SHA2-384,
or SHA2-512, you can select AES-CBC-128, AEC-CBC-256, AES-GCM-128,
AES-GCM-256, NULL, or Auto. The default setting is auto.
If the IPSec Suite B Preset field is set to None, and the IPSec
Authentication algorithm field is set to AES-GMAC-128 or
AES-GMAC-256, this field is automatically set to NULL.
IPSec anti-replay Select a size from the drop-down list or Disable to disable the IPSec
window anti-replay window.
Field Description
6. Click Save.
Delete a Tunnel
To delete a tunnel listed in the table on the Underlay or Passthrough subtab of the Tunnels
dialog box, click the corresponding delete icon (X) in the last column.
– This requires building secure and compatible third-party IPSec tunnels from Edge-
Connect devices to non-EdgeConnect devices in the data center or cloud.
– When you create the tunnel, the Service Name in the Business Intent Overlay’s Inter-
net Traffic Policies must exactly match the Peer/Service specified in the Passthrough
tunnel configuration.
– To load balance, create two or more passthrough IPSec tunnels and, in the Business
Intent Overlay, ensure that they all specify the same Service Name in the Internet
Traffic Policies.
• GCM-128
• GCM-256
• GMAC-128
• GMAC-256
Each preset includes a predetermined set of IKE and ESP (IPSec) cryptographic algorithms. By
selecting an IPSec Suite B preset, you can streamline the algorithm aspect of your tunnel setup
rather than selecting individual algorithms. However, you can select individual algorithms if
you want to. To select a preset, use the IPSec Suite B Preset drop-down field on the Add
Tunnel or Modify Tunnel dialog box.
The following tables show the IPSec Suite B presets in the header row and provide the associ-
ated algorithm setups for the IKEv2 and ESP (IPSec) stages.
IKEv2 Stage
Notice in the second table that the encryption and data authentication is done in one step for
GCM. For GMAC, there is no encryption.
Tunnel Troubleshooting
The Tunnel Troubleshooting dialog box provides some basic diagnostic results for SD-WAN
fabric tunnels. HPE Networking Technical Assistance Center (TAC) can request that you capture
and send this diagnostic information.
Tunnel Exception
Configuration > Networking > Tunnels > Tunnel Exception
Orchestrator includes a tunnel exception feature that enables you to specify tunnel transac-
tions between overlays. There are two ways you can enable this feature in Orchestrator.
You can configure tunnel exceptions through the Tunnel Exception tab.
1. Select the two appliances that you do not want connected via a tunnel.
2. Enter the Interface Labels.
The interface label can be any type of connection, such as any, MPLS, Internet, or LTE. Speci-
fying the label excludes appliances within a given network to communicate with that particular
appliance.
NOTE: Use the description field to add a comment if you want to indicate why you are adding
an exception.
Field Description
Field Description
1. Choose whether you want to enable the DNS Proxy by selecting ON or OFF.
2. Select the name of the loopback interface or the LAN-side label associated with your DNS
proxy.
3. Enter the IP addresses for Server A in the Server A Addresses field.
4. Choose whether you want caching to be ON or OFF. If selected, the domain name to the
IP address mapping is cached. By default, caching is ON.
5. Enter the domain names of the Server A for the above IP addresses.
6. Enter Server B IP addresses in the Server B Addresses field. Server B will be used if
there are no matches to the Server A domains.
NOTE: You can Clear DNS Cache. This will erase the domain name to the IP address mapping
you had cached for both Server A and B.
You might also want to create a Route Policy entry when multiple tunnels exist to the remote
peer, and you want the appliance to dynamically select the best path based on one of these
criteria:
• Load balancing
• Lowest loss
• Lowest latency
• Specified tunnel
Manage these instances on the Templates tab, or select the Edit icon to manage Routing
policies directly for a particular appliance.
If you are deploying an SD-WAN network and setting up Internet breakout from the branch,
you must create manual route policy entries for sanctioned SaaS applications or Guest WiFi.
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
You might also want to create a Route Policy entry when multiple tunnels exist to the remote
peer, and you want the appliance to dynamically select the best path based on one of these
criteria:
• Load balancing
• Lowest loss
• Lowest latency
• Specified tunnel
Manage these instances on the Templates tab, or click the Edit icon to manage Route policies
directly for a particular appliance.
If you are deploying an SD-WAN network and setting up Internet breakout from the branch,
you must create manual route policy entries for sanctioned SaaS applications or Guest WiFi.
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• A wildcard can only be used to define an entire octet. For example, 10.13*.*.64-95 is not
supported. Use 10.130-139.*.64-95 to specify this range.
• The same rules apply to IPv6 addressing.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
• The appliance encapsulates optimized traffic. This adds an IP outer header to packets
for travel across the WAN. This outer header contains the WAN QoS DSCP marking.
• LAN QoS – The DSCP marking applied to the IP header before encapsulation.
• WAN QoS – The DSCP marking in the encapsulating outer IP header. The remote appli-
ance removes the outer IP header.
• The appliance applies the QoS Policy’s DSCP markings to all pass-through flows—shaped
and unshaped.
• Pass-through traffic does not receive an additional header, so it is handled differently:
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• The appliance encapsulates optimized traffic. This adds an IP outer header to packets
for travel across the WAN. This outer header contains the WAN QoS DSCP marking.
• LAN QoS – The DSCP marking applied to the IP header before encapsulation.
• WAN QoS – The DSCP marking in the encapsulating outer IP header. The remote appli-
ance removes the outer IP header.
• The appliance applies the QoS Policy’s DSCP markings to all pass-through flows—shaped
and unshaped.
• Pass-through traffic does not receive an additional header, so it is handled differently:
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• The desired Template Group has the QoS maps you need.
• You have applied the Template Group to the appliances you want to schedule.
TIP: To specify the timezone for scheduled jobs and reports, use the Schedule Timezone win-
dow (Orchestrator > Software & Setup > Setup > Timezone for Scheduled Jobs).
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
Set Actions
NOTE: The slow LAN alert goes off when the loss has fallen below
80% of the specified value configured in the TCP Accel Options
dialog box.
Protocol Acceleration Provides explicit configuration for optimizing SSL, SRDF, Citrix,
and iSCSI protocols. In a network environment, it is possible that
not every appliance has the same optimization configurations
enabled. Therefore, the site that initiates the flow (the client)
determines the state of the protocol-specific optimization.
CAUTION: Because changing these settings can affect service, it is recommended that you do
not modify these without direction from Support.
TCP Acceleration Options
Option Description
Adjust MSS to Tunnel Limits the TCP MSS (Maximum Segment Size) advertised by the
MTU end hosts in the SYN segment to a value derived from the Tunnel
MTU (Maximum Transmission Unit). This is TCP MSS = Tunnel MTU
– Tunnel Packet Overhead.
A use case for disabling this feature is when the end host uses
Jumbo frames.
Auto Reset Flows NOTE: Whether this feature is enabled or not, the default
behavior when a tunnel goes Down is to automatically reset the
flows.
If enabled, it resets all TCP flows that are not accelerated, but
should be (based on policy and on internal criteria like a Tunnel
Up event).
Resetting
SYN packet was not seen (so this flow was either part of WCCP
redirection or it already existed when the appliance was inserted
in the data path).
Enable TCP SYN option Controls whether or not the proprietary TCP SYN option is
exchange forwarded on the LAN side. Enabled by default, this feature
detects if there are more than two EdgeConnect appliances in the
flow’s data path, and optimizes accordingly.
Option Description
End to End FIN This feature helps to fine tune TCP behavior during a connection’s
Handling graceful shutdown event. When this feature is ON (Default), TCP
on the local appliance synchronizes this graceful shutdown of the
local LAN side with the LAN side of the remote appliance. When
this feature is OFF (Default TCP), no such synchronization
happens and the two LAN segments at the ends gracefully shut
down, independently.
IP Block Listing If selected, and if the appliance does not receive a TCP SYN-ACK
from the remote end within five seconds, the flow proceeds
without acceleration and the destination IP address is blocked for
one minute.
Keep Alive Timer Allows changing the Keep Alive timer for the TCP connections.
First Timeout (Idle) – Time interval until the first Keep Alive
timeout.
LAN Side Window This setting allows the appliance to present an artificially lowered
Scale Factor Clamp Window Scale Factor (WSF) to the end host. This reduces the need
for memory in scenarios in which there are many out-of-order
packets being received from the LAN side. These out-of-order
packets cause much buffer utilization and maintenance.
Per-Flow Buffer (Max LAN to WAN Buffer and Max WAN to LAN Buffer)
Option Description
Route Policy Override Tries to override asymmetric route policy settings. It emulates
auto-opt behavior by using the same tunnel for the returning
SYN+ACK as it did for the original SYN packet.
Use the Templates tab to create and manage Optimization policies, or click the edit icon to
directly manage Optimization policies for a particular appliance.
Priority
• If you are using Orchestrator templates to add rules, Orchestrator will delete all entries
from 1000 – 9999 before applying its policies.
• You can create rules with higher priority than Orchestrator rules (1 – 999) and rules with
lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by 10 from the previous rule. The prior-
ity can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
Set Actions
NOTE: The slow LAN alert goes off when the loss has fallen below
80% of the specified value configured in the TCP Accel Options
dialog box.
Option Description
Adjust MSS to Tunnel MTU Limits the TCP MSS (Maximum Segment Size)
advertised by the end hosts in the SYN segment to a
value derived from the Tunnel MTU (Maximum
Transmission Unit). This is TCP MSS = Tunnel MTU –
Tunnel Packet Overhead.
Resetting
SYN packet was not seen (so this flow was either
part of WCCP redirection, or it already existed when
the appliance was inserted in the data path).
Enable TCP SYN option exchange Controls whether or not the proprietary TCP SYN
option is forwarded on the LAN side. Enabled by
default, this feature detects if there are more than
two EdgeConnect appliances in the flow’s data path,
and optimizes accordingly.
Option Description
End to End FIN Handling This feature helps to fine tune TCP behavior during
a connection’s graceful shutdown event. When this
feature is ON (Default), TCP on the local appliance
synchronizes this graceful shutdown of the local
LAN side with the LAN side of the remote appliance.
When this feature is OFF (Default TCP), no such
synchronization happens and the two LAN
segments at the ends gracefully shut down,
independently.
IP Block Listing If selected and if the appliance does not receive a
TCP SYN-ACK from the remote end within five
seconds, the flow proceeds without acceleration
and the destination IP address is blocked for one
minute.
Keep Alive Timer Allows us to change the Keep Alive timer for the TCP
connections.
Option Description
Preserve Packet Boundaries Preserves the packet boundaries end to end. If this
feature is disabled, the appliances in the path can
coalesce consecutive packets of a flow to use
bandwidth more efficiently.
Option Description
• Inbound NAT. The appliance automatically creates a source NAT (Network Address
Translation) map when retrieving subnet information from the Cloud Portal. This
ensures that traffic destined to SaaS servers has a return path to the appliance from
which that traffic originated.
• Outbound NAT. The appliance and server are in the cloud, and the server accesses the
internet. As in the example below, a Citrix thin client accesses its cloud-based server, and
the server accesses the internet.
For deployments in the cloud, best practice is to NAT all traffic—either inbound (WAN-to-
LAN) or outbound (LAN-to-WAN), depending on the direction of initiating request. This avoids
black-holing that can result from cloud-specific IP addressing requirements.
• Enabling NAT all applies NAT policies to pass-through traffic as well as optimized traf-
fic, ensuring that black-holing does not occur. NAT all on outbound only applies pass-
through traffic.
• If Fallback is enabled, the appliance moves to the next IP (if available) when ports are
exhausted on the current NAT IP.
In general, when applying NAT policies, configure separate WAN and LAN interfaces to ensure
that NAT works properly. You can do this by deploying the appliance in Router mode in-path
with two (or four) interfaces.
Advanced Settings
The appliance can perform source network address translation (Source NAT or SNAT) on
inbound or outbound traffic.
There are two types of NAT policies:
• Dynamic – Created automatically by the system for inbound NAT when the SaaS Opti-
mization feature is enabled and SaaS service(s) are selected for optimization. The appli-
ance polls the Cloud Intelligence Service for a directory of SaaS services, and NAT policies
are created for each of the subnets associated with selected SaaS service(s), ensuring that
traffic destined for servers in use by those SaaS services has a return path to the appli-
ance. Dynamic policy numbering assigns priority numbers (in the range 40000 to 50000)
to individual policies within a NAT map. The default (no-NAT) policy is numbered 65535.
• Manual – Created by the administrator for specific IP addresses / ranges or subnets.
When assigning priority numbers to individual policies within a NAT map, first view dy-
namic policies to ensure that the manual numbering scheme does not interfere with
dynamic policy numbering (that is, the manually assigned priority numbers cannot be in
the range 40000 to 50000). The default (no-NAT) policy is numbered 65535.
The NAT policy map has the following criteria and Set Actions:
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• Even when using a range or a wildcard, the IPv4 address must be specified in the 4-octet
format, separated by the dot notation. For example, A.B.C.D.
• Range is specified using a single dash. For example, 128-129.
• Wildcard is specified as an asterisk (____*).
• Range and Wildcard can both be used in the same address, but an octet can only contain
one or the other. For example, 10.136-137.*.64-95.
• A wildcard can only be used to define an entire octet. For example, 10.13*.*.64-95 is not
supported. Use 10.130-139.*.64-95 to specify this range.
• The same rules apply to IPv6 addressing.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
Set Actions
NAT Type
Option Description
NAT Direction
Option Description
NAT IP
Option Description
auto Select if you want to NAT all traffic. The appliance then picks the first
available NAT IP/Port.
tunnel Select if you want to NAT tunnel traffic only. Applicable only for inbound
NAT, as outbound does not support NAT on tunnel traffic.
[IP address] Select if you want to make NAT use this IP address during address
translation.
For Fallback, if the IP address is full, the appliance uses the next available IP address.
When you select a specific IP, ensure that the routing is in place for NAT-ted return traffic.
Merge / Replace
• The Basic view shows whether NAT is enabled on all Inbound and Outbound.
• The Advanced view displays all the NAT map rules.
• Inbound NAT. The appliance automatically creates a source NAT (Network Address
Translation) map when retrieving subnet information from the Cloud Portal. This
ensures that traffic destined to SaaS servers has a return path to the appliance from
which that traffic originated.
• Outbound NAT. The appliance and server are in the cloud, and the server accesses the
internet. As in the example below, a Citrix thin client accesses its cloud-based server, and
the server accesses the internet.
For deployments in the cloud, best practice is to NAT all traffic—either inbound (WAN-to-
LAN) or outbound (LAN-to-WAN), depending on the direction of initiating request. This avoids
black-holing that can result from cloud-specific IP addressing requirements.
• Enabling NAT all applies NAT policies to pass-through traffic as well as optimized traf-
fic, ensuring that black-holing does not occur. NAT all on outbound only applies pass-
through traffic.
• If Fallback is enabled, the appliance moves to the next IP (if available) when ports are
exhausted on the current NAT IP.
In general, when applying NAT policies, configure separate WAN and LAN interfaces to ensure
that NAT works properly. You can do this by deploying the appliance in Router mode in-path
with two (or four) interfaces.
Advanced Settings
The appliance can perform source network address translation (Source NAT or SNAT) on
inbound or outbound traffic.
• Dynamic – Created automatically by the system for inbound NAT when the SaaS Opti-
mization feature is enabled and SaaS service(s) are selected for optimization. The appli-
ance polls the Cloud Intelligence Service for a directory of SaaS services, and NAT policies
are created for each of the subnets associated with selected SaaS service(s), ensuring that
traffic destined for servers in use by those SaaS services has a return path to the appli-
ance. Dynamic policy numbering assigns priority numbers (in the range 40000 to 50000)
to individual policies within a NAT map. The default (no-NAT) policy is numbered 65535.
• Manual – Created by the administrator for specific IP addresses / ranges or subnets.
When assigning priority numbers to individual policies within a NAT map, first view dy-
namic policies to ensure that the manual numbering scheme does not interfere with
dynamic policy numbering (that is, the manually assigned priority numbers cannot be in
the range 40000 to 50000). The default (no-NAT) policy is numbered 65535.
The NAT policy map has the following criteria and Set Actions:
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• Even when using a range or a wildcard, the IPv4 address must be specified in the 4-octet
format, separated by the dot notation. For example, A.B.C.D.
• Range is specified using a single dash. For example, 128-129.
• Wildcard is specified as an asterisk (____*).
• Range and Wildcard can both be used in the same address, but an octet can only contain
one or the other. For example, 10.136-137.*.64-95.
• A wildcard can only be used to define an entire octet. For example, 10.13*.*.64-95 is not
supported. Use 10.130-139.*.64-95 to specify this range.
• The same rules apply to IPv6 addressing.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
Set Actions
NAT Type
Option Description
NAT Direction
Option Description
NAT IP
Option Description
auto Select if you want to NAT all traffic. The appliance then picks the first
available NAT IP/Port.
tunnel Select if you want to NAT tunnel traffic only. Applicable only for inbound
NAT, as outbound does not support NAT on tunnel traffic.
Option Description
[IP address] Select if you want to make NAT use this IP address during address
translation.
For Fallback, if the IP address is full, the appliance uses the next available IP address.
When you select a specific IP, ensure that the routing is in place for NAT-ted return traffic.
Field Description
Source IP/Subnet Source of the WAN device managing the LAN device(s) specified in
the destination.
Destination IP/Subnet Address of the LAN device(s) managed remotely.
The second mode is when translate mode is enabled. When enabled, the EdgeConnect WAN
interface performs destination NAT to reach LAN side device(s) from an external network.
Complete the following steps to enable the translate mode. This represents the process of
DNAT (Destination Network Translation).
Field Description
Source IP/Subnet Source of the WAN device managing the LAN device(s) specified
in the destination.
Destination IP/Subnet Address of the WAN interface IP.
Destination Port/Range Port/range of the LAN device(s) that are managed remotely.
Protocol Select the protocol you want to apply: UDP, TCP, ICMP, Any. If
you select Any, the Destination and Translated Ports have a
default value that need to be between 0-100. If the value
exceeds, 100 a warning appears.
Translated IP IP address of the LAN device accessed inside your network.
Translated Port/Range Port/range of the LAN device accessed inside your network.
Source Interface Source interface name.
Segment Name of the segment being used.
Comment Any additional details.
Additional Information
• Interface Modes
Port forwarding is used only when you have ‘stateful’ or ‘stateful+snat’ configured on
interfaces. It does not apply when you have ‘Allow All’ or ‘Harden’ configured.
• Security Policies
*If ‘security policies’ are configured, make sure they allow the traffic specified in the port
forwarding rules.
• You can also reorder the appliances associated with inbound port forwarding by select-
ing Reorder when adding a rule.
This tab displays the Security Policies, which manage traffic between firewall zones.
• Range and Wildcard can both be used in the same address, but an octet can only contain
one or the other. For example, 10.136-137.*.64-95.
• A wildcard can only be used to define an entire octet. For example, 10.13*.*.64-95 is not
supported. Use 10.130-139.*.64-95 to specify this range.
• The same rules apply to IPv6 addressing.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
1. Select the default logging level to be applied to all “Deny All” events.
2. Select the Source and Destination Segment.
3. Click the cell for the source and destination zone to open the rule editor.
4. Click Add Rule to create a new rule.
5. Modify the following fields in a new or existing rule:
Field Description
Field Description
Field Description
Priority For ACL rules, you can set the priority to a value within the range 1 to
65535. When adding a rule, the priority is incremented by ten from the
previous rule. You can change the priority, but this default behavior
helps ensure that you can insert new rules without having to change
subsequent priorities.
Match Criteria Configured ACL match criteria associated to the appliance. See below
for more information about Match Criteria.
Permit Whether the ACL is set to Permit or Deny.
Permit allows the matching traffic flow to proceed to the policy entry’s
associated SET actions.
Click the edit icon to make add, delete, or modify rules to your ACLs.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
NOTE: Additional attributes under the Address Map parameter can be used as match cri-
teria. These attributes are secondary parameters to the address map, so the attributes
are evaluated for a policy match only when the configured address map parameter
matches the flow. To configure these attributes, click +Attributes.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Address Groups
Configuration > Templates & Policies > ACLs > Address Groups
Use the Address Groups tab to view and manage address groups in your SD-WAN network.
An address group is a logical collection of IP hosts or subnets that can be referenced in source
or destination matching criteria in the zone based firewall and security policies (route, QOS,
optimization, and so forth).
NOTE: Orchestrator supports up to 8MB of address group definitions. For current usage,
check the Address Groups UI.
1. Click Add Group to open the Add Address Group dialog box.
Field Description
Group name Enter a unique name for the group, up to 64 characters long.
3. Click Add to create the address group, or click Cancel to close the dialog box without
making any changes.
1. Select the address group to which you want to add a rule from the drop-down list above
the table.
2. Click Add Rule to open the Add Rule dialog box.
3. Provide the details for the new rule in the fields provided (see field descriptions in Add
an Address Group).
4. Click Add to create the rule or click Cancel to close the dialog box without making any
changes.
1. Select the address group you want to delete from the drop-down list above the table.
2. Click Delete Group.
A confirmation dialog box opens.
3. Click Delete to confirm your choice and permanently remove the selected group and all
of its rules. Otherwise, click Cancel to return to the list without deleting the group.
3. Open the saved file in Excel or another program to view or modify its contents.
NOTE: When editing exported rules and address groups, you can modify the included or
excluded IPs, included groups, or comments to overwrite the same rule when imported.
If you modify the group name on a rule, however, it will create a new rule when imported.
2. Click Choose File, locate and select the CSV file to be imported, and then click Open.
3. Review the groups and rules to be imported.
4. Click Save to import the file and merge with or replace the existing address groups, or
click Cancel to close the dialog box without making any changes.
• To edit the rule, modify the available fields, and then click Save.
• To delete the rule, click Delete.
Service Groups
Configuration > Templates & Policies > ACLs > Service Groups
Use the Service Groups tab to view and manage service groups in your SD-WAN network. A
service group is a logical collection of protocols and ports that can be referenced in source
or destination matching criteria in the zone based firewall and security policies (route, QOS,
optimization, and so forth).
NOTE: Orchestrator supports up to 4MB of service group definitions. For current usage, check
the Service Groups UI.
1. Click Add Group. The Add Service Group dialog box opens.
Group name All Enter a unique name for the group, up to 64 characters
long.
Groups to TCP, Enter the name of one or more service groups to include.
include UDP
NOTE: Group inclusion only supports two levels of nesting.
For example, if Group1 includes Group2 and Group2
includes Group3, you could not include Group1 anywhere
because it already contains two levels of nested groups.
Groups to TCP, Enter the name of one or more service groups to exclude, in
exclude UDP the case where you are already including a group that
includes multiple groups.
ICMP types ICMP For ICMP, add one or more message types to include.
Multiple types and ranges are supported (e.g., 1, 2, 4-8).
Comment All Enter an optional comment that describes the service group
and how it might be used.
3. Click Add to create the service group or click Cancel to close the dialog box without
making any changes.
1. Select the service group to which you want to add a rule from the drop-down list above
the table.
2. Click Add Rule. The Add Rule dialog box opens.
3. Provide the details for the new rule in the fields provided (see field descriptions in Add
a Service Group).
4. Click Add to create the rule or click Cancel to close the dialog box without making any
changes.
1. Select the service group you want to delete from the drop-down list above the table.
2. Click Delete Group.
A confirmation dialog box opens.
3. Click Delete to confirm your choice and permanently remove the selected group and all
of its rules. Otherwise, click Cancel to return to the list without deleting the group.
2. In the save dialog box, browse to the location where you want to save the file, provide a
name for the file, and then click Save.
3. Open the saved file in Excel or another program to view or modify its contents.
NOTE: When editing exported rules and service groups, you can modify the protocol,
inclusions, exclusions, ICMP types, or comments to overwrite the same rule when im-
ported. If you modify the group name on a rule, however, it will create a new rule when
imported.
2. Click Choose File, locate and select the CSV file to be imported, and then click Open.
3. Review the groups and rules to be imported.
4. Click Save to import the file and merge with or replace the existing service groups, or
click Cancel to close the dialog box without making any changes.
• To edit the rule, modify the available fields, and then click Save.
• To delete the rule, click Delete.
Shaper Tab
Configuration > Templates & Policies > Shaping > Shaper
The Shaper provides a simplified way to globally configure QoS (Quality of Service) on the
appliances.
Outbound Shaping is always enabled.
Inbound Shaping is disabled by default and can be enabled by clicking the Edit icon for a
specific interface.
Traffic shaping allocates bandwidth as a percentage of the system bandwidth. Shaper pa-
rameters are organized into ten traffic classes. Four traffic classes are preconfigured and
named real-time, interactive, default, and best effort. After compressing (deduplicating)
all the outbound tunnelized and pass-through–shaped traffic, the system either applies policy
settings globally or upon each interface, shaping traffic as it exits the interface.
To manage Shaper settings for an appliance’s system-level WAN Shaper, access the Shaper
template. For minimum and maximum bandwidth, you can configure traffic class values as
a percentage of total available system bandwidth and as an absolute value. The appliance
always provides the larger of the minimum values and limits bandwidth to the lower of the
maximum values.
• Max overrides Min if you set Min Bandwidth to a value greater than Max Bandwidth.
Field Description
Field Description
Field Description
Max BW Absolute (kbps) This limits the maximum bandwidth that a traffic class can
use to an absolute value (kbps). You can specify a maximum
absolute value to cap the bandwidth for downloads and
streaming.
Max BW Actual (kbps) This specifies the actual maximum level of service when
total system bandwidth declines. Max BW is equal to the
smallest of the following values: Licensed BW, system BW,
or the sum of the BW of the configured interfaces.
Max Wait Time (ms) Any packets waiting longer than the specified Max Wait
Time are dropped.
Rate Limit (kbps) You can set per-flow rate limit that a traffic class uses by
specifying a number in the Rate Limit column. For no limit,
use 0 (zero).
Enable Specifies the shaping enabled status. Shaping is always
enabled for outbound traffic and by configuration for
inbound traffic.
Per Interface Indicates if shaping is for each interface or for the gateway
as a unit.
• Configuration – Displays a table of SaaS optimization configurations for the listed appli-
ances.
• Monitoring – Displays a table of monitoring information related to SaaS optimization for
the listed appliances that have been configured for SaaS optimization.
• Export – Exports the displayed table as a .csv file. The exported file depends on whether
the SaaS Optimization Configuration table or the SaaS Optimization Monitoring table is
displayed when you click this button.
• Enable SaaS Optimization – Select this check box to enable the appliance to contact the
Cloud Intelligence Service and download information about SaaS services.
• RTT Calculation Interval – Enter a value to specify how frequently Orchestrator recal-
culates the Round Trip Time for the enabled applications.
• RTT Ping Interface – Select the interface to use to ping the enabled SaaS subnets for
Round Trip Times. The default interface is wan0.
Field Description
Field Description
Add subnet sharing entries locally for subnets within RTT threshold
Auto-generate dynamic NAT rules for SFDC (but not for unchecked
services)
RTT Threshold Amount of time (in ms) allotted that specifies how often Orchestrator
will recalculate the Round Trip Time for the enabled applications.
NOTE: You might want to set a higher RTT Threshold value to see a
broader scope of reachable data servers for any given SaaS
application. As best practice, production RTT Threshold values should
not exceed 50 ms.
Domains Domain names where the SaaS is applied.
SaaS ID Unique identifier assigned to the SaaS application (for use in SaaS
Optimization).
For more detailed information about SaaS optimization, navigate to the SaaS Optimization
template.
• UDP Port – Matches flows based on layer 4 UDP port. Matches on the first packet.
• TCP Port – Matches flows based on layer 4 TCP port. Matches on the first packet.
• Domain Name – Uses DNS, HTTP Host Header, and HTTPS/SNI snooping to derive a
domain name for each flow. It is expressed as example.com or *.example.com. The DNS
snooping mechanism matches on the first packet. The snooped DNS queries must be
cleartext and must transit the EdgeConnect in both directions.
NOTE: Multiple domain names can be associated with the same IP address. When this hap-
pens, the snooping mechanism needs up to six packets to determine the domain name and
cannot match on the first packet. However, when a policy specifies a domain name, the sys-
tem gives precedence to it when associating the flow with a policy. To more deterministically
ensure that a domain name you specify is given precedence, use the Application Definition
confidence level to enable the system to match the domain name to a flow according to your
intention on the first packet received back from the DNS server.
You can use any of these application pipelines to define a new application, and you can modify
or disable an existing application. Multiple application definitions can match at the same time.
When this occurs the application with the highest confidence configured (1-100) is used.
Orchestrator automatically checks the Cloud Portal for updated application definitions every
24 hours by default (Auto update set to ON). Application definition data on the Cloud Portal is
updated generally once per month. If new definitions are discovered, Orchestrator downloads
the data, merges it with the applications, and pushes the changes to appliances in the network.
You can also force an update at any time by clicking Update Now.
1. Navigate to Configuration > Templates & Policies > Applications & SaaS > Application
Definitions.
6. To enable AppExpress for the application, continue to Enable AppExpress for an Appli-
cation.
7. Click Apply.
The definition appears in the Advanced App Definitions section.
NOTE: To find a user-created definition in the Advanced App Definitions section, click the
appropriate tab for the type of definition, such as IP Protocol or UDP Port, and then click
Modified.
Application Definition Fields
Field Description
Name Enter a name for the application. This application name is used
throughout the EdgeConnect system to match and apply various
policies. Application names are not case-sensitive.
NOTE: When you change an application name, you must also change it
in any associated policies, such as Overlay ACLs or Firewall policies.
Protocol Number Applies to IP Protocol. Enter the protocol number for the application.
Port Number Applies to UDP Port and TCP Port. Enter the port number for the
application.
Domain Applies to UDP Port, TCP Port, and Compound. Enter the domain for
the application.
IP range(IPV4 Applies to Address Map. Enter the range of IP addresses that are
only) included.
Organization Applies to Address Map. Enter the name of the organization that owns
the range of IP addresses.
Country Applies to Address Map. Select the country where the organization
that owns the range of IP addresses resides.
Protocol Applies to Compound. Select the type of protocol used for the
application.
Port Applies to Compound. Enter the port number for the application.
IP/Subnet Applies to Compound. Enter the IP address or subnet for the
application.
Field Description
Geo Location Applies to Compound. Matches flows with IPs associated with a
specific country. Select the country from the drop-down list.
Address Map Applies to Compound. Matches flows with IPs contained within an
Address Map. Select the address map from the drop-down list.
Interface Applies to Compound. Matches flows that are inbound to the
EdgeConnect through the specified interface or label. Select the
interface or label from the drop-down list.
DSCP Applies to Compound. Click the check box to match the first DSCP
value observed for the flow.
Domains Deprecated. Applies to SaaS Optimization.
Addresses Deprecated. Applies to SaaS Optimization.
Notes Applies to all except SaaS. This is a text-entry field where you can enter
any notes or information about the application definition.
Confidence Used when two or more application definitions match the same flow.
The application with the highest Confidence value is assigned to the
flow. Enter a value of 1 to 100. The higher the number, the higher the
confidence.
Microsoft Applies to Address Map. Allows filtering by Microsoft Instance type,
Instance such as “WorldWide”, “USGovDoD”, and “China”. Select the instance
from the drop-down list.
Microsoft Applies to Address Map. Matches the Microsoft-assigned endpoint
Category category, which includes the following (select one):
1. Navigate to Configuration > Templates & Policies > Applications & SaaS > Application
Definitions.
2. Click Show Advanced App Definitions.
3. Locate the application in the advanced definitions list, and then click the edit icon.
The Application Definition dialog box opens.
4. Enter the following information based on the level of monitoring you want to apply to
the application:
Field Description
Field Description
User Experience Enter the two threshold values (in milliseconds) for the application
Thresholds performance. These values are measures of latency and are what the
Target QoE is derived from. The defaults are 100 ms for the threshold
between Satisfied and Tolerable, and 300 ms for the threshold
between Tolerable and Frustrated. When determining the threshold
values, keep the following definitions in mind:
Tolerable – If latency for the application falls in this range, users will
have a tolerable experience with the application, but it could be better.
3. Click Delete.
The definition is deleted and all dialog boxes close.
NOTE: To avoid performance issues, it is strongly recommended that you assign an application
to no more than three groups.
Field Description
Field Description
NOTE: Applications that are in the group are automatically added to the
BIO that is chosen and you do not need to add them to the BIO manually
because AppExpress overrides Overlay ACLs and sits logically in front of
Overlays.
Eligible Click the check box for each transport that that you want AppExpress to
transports poll across for this group.
2. To add applications to the group, drag and drop applications from the AppExpress Ap-
plications box to the [Realtime] Group box.
3. (optional) Click Show Advanced to see additional settings. If you want to change from
the default options for these settings, enter information in the following fields:
Field Description
Ping interval Determines how frequently synthetic probes are sent to the
applications in the group. Measured in seconds. The default is 10
seconds.
Source loopback The loopback interface for the group. It is recommended to use
LOOPBACK for sourcing synthetic probes and for proxied DNS
queries. It automatically sets itself to use Orchestrated Loopbacks.
Field Description
DNS for ping and Enter the DNS that will be used to send probes (pings) and monitor
user traffic user traffic. The default is 8.8.8.8.
NOTE: Leave this field blank to disable DNS proxy for applications in
this group.
NOTE: If you plan to enable DNS proxy and deploy AppExpress Only
mode, you must push an empty DNS template to the appliances
before you apply any AppExpress groups to the appliances. See
Templates Overview.
User QoE interval Determines how frequently the Apdex score is calculated for user
flows and how often a new path can be chosen.
Ping QoE interval Determines how frequently the Ping QoE is calculated and how
often the path hunting is reset.
4. Click Save.
To edit a group:
1. Click the edit icon next to the group you want to edit.
The Edit AppExpress group dialog box opens.
2. Edit the settings as needed.
3. Click Save.
The alerts are triggered with rising and falling threshold crossing events (that is, floor and
ceiling levels). For both levels, one value raises the alarm while another value clears it.
• When you configure appliance and tunnel TCAs with an Orchestrator template, all alerts
apply globally, so all of an appliance’s tunnels have the same alerts.
• To create a tunnel-specific alert, navigate to Configuration > Networking > Tunnels>
Tunnels, select the tunnel, click the edit icon to access the tunnel directly, and then click
the icon in the Alert Options column. Make your changes, and then click OK.
Times to Trigger – A value of 1 triggers an alarm on the first threshold crossing instance.
ON by Default
• Appliance Capacity – Triggers when an appliance reaches 95% of its total flow capacity.
It is not configurable and can be cleared only by an operator.
• File-system utilization – Percent of non-Network Memory disk space filled by the appli-
ance. This TCA cannot be disabled.
• Tunnel latency – Measured in milliseconds, the maximum latency of a one-second sam-
ple within a 60-second span.
OFF by Default
Default Values
[Rising Raise; Rising
TCA Default Clear; Falling Raise; allow allow
Name [ON or OFF] Falling Clear] rising falling
Appliance Level
WAN-side transmit OFF 1 Gbps; 1 Gbps; 0; 0 4 4
throughput
LAN-side receive OFF 1 Gbps; 1 Gbps; 0; 0 4 4
throughput
Total number of OFF 256,000, 256,000; 0; 0 4 4
optimized flows
Total number of OFF 256,000, 256,000; 0; 0 4 4
flows
File-system- ON 95%; 85%; 0%; 0% 4 –
utilization (cannot be
disabled)
Tunnel Level
Tunnel latency ON 1000; 850; 0; 0 4 –
Tunnel loss pre-FEC OFF 100%; 100%; 0%; 0% 4 –
Tunnel loss post-FEC OFF 100%; 100%; 0%; 0% 4 –
Tunnel OOP pre-POC OFF 100%; 100%; 0%; 0% 4 –
Tunnel OOP OFF 100%; 100%; 0%; 0% 4 –
post-POC
Default Values
[Rising Raise; Rising
TCA Default Clear; Falling Raise; allow allow
Name [ON or OFF] Falling Clear] rising falling
IP SLA Tab
Configuration > Templates & Policies > TCAs > IP SLA
Monitoring > Performance > IP SLA Summary
Using a polling process, IP SLA (Internet Protocol Service Level Agreement) tracking provides
the ability to generate specific actions in the network that are completely dependent on the
state of an IP interface or tunnel. The goal is to prevent black-holed traffic. For example,
associated IP subnets could be removed from the subnet table, and also from subnet sharing,
if the LAN-side interfaces on an appliance go down.
This tab displays all of the IP SLA rules configured on the selected appliances. To add or modify
rules, click the edit icon to the left of any row in the table. To view IP SLA trends over time for
an interface or tunnel, click the Realtime and Historical Charts icon. You can view trends for
both latency and loss.
• Two passthrough tunnels configured for Internet breakout and High Availability.
• If the Primary passthrough tunnel goes down, traffic goes to Backup tunnel.
• The IP SLA Rule would look like this, with the same tunnel specified for the Down and
Up Actions.
• Two passthrough tunnels configured for Internet breakout and High Availability.
• If the Primary passthrough tunnel goes down, traffic goes to Backup tunnel.
• The IP SLA Rule would look like this, with the same tunnel specified for the Down and
Up Actions.
• In the URL(s) field, the protocol identifier is required only when specifying HTTPS, as in
__https://__www.google.com.
###### Example
#4 – Monitor Interface (WAN0) to Ensure High Availability
• If WAN0 goes down on the VRRP Master, we want to decrease its Priority so that traffic
goes to the VRRP Backup.
• Its IP SLA Rule would look like this, with the Default Subnet Action being to revert to
the original Priority.
NOTE: In this instance, the WAN0 interface was given the label MPLS to match the service
to which it connected.
• To monitor the VRRP router state, use VRRP Monitor and specify the interface on which
the VRRP instance is configured.
In this example, it is LAN0.
• Here we are looking at an instance where the VRRP role changes, but priority does not,
for whatever reason.
• Its IP SLA Rule would look like this, with the Default Subnet Action being to revert to
the original Priority.
NOTE: In this instance, the WAN0 interface was given the label MPLS to match the service
to which it connected.
• Another option would be to specify Down Action = Modify Subnet Metric. The Web UI
automatically produces another field in which you can add a positive value to the current
subnet metric. Up Action = Default Subnet Action would return the subnet metric to
its original value.
Monitor
There are four options to choose from for a Monitor:
Option Description
NOTE: Both HTTP and HTTPS require a response of 200. Redirects are not
supported.
NOTE: Using HTTPS as a monitor for IP SLA with multiple targets can
cause potential problems. HTTPS does not provide any additional benefit
about the path check.
Option Description
VRRP Monitor Monitors the VRRP router state (TRUE if Master; FALSE if Backup) for a
VRRP instance(s) on an interface.
Based on the Monitor chosen, the Web UI displays the appropriate fields and options.
Actions
There are eight available Down Actions:
Remove Auto Subnet Remove from the subnet table an auto subnet for a port
(including all VLAN and subinterface subnets).
Increase VRRP Priority Increase the configured VRRP router priority by a delta amount.
Decrease VRRP Priority Decrease the configured VRRP router priority by a delta amount.
Enable Tunnel Enable a passthrough (internet breakout) tunnel Up for IP
Tracking (SLA) purposes.
Disable Tunnel Disable a passthrough (internet breakout) tunnel Up for IP
Tracking (SLA) purposes. The tunnel no longer can be used for
load balancing purposes (when load balancing traffic between
multiple passthrough tunnels), although it still can be used as a
last resort for traffic forwarding.
Disable Subnet Sharing Disable subnet sharing of subnets to other EdgeConnect peers
on the appliance.
Modify Subnet Metric Add a metric delta to the metric of all subnets shared with
EdgeConnect peers.
Advertise Subnets Advertise subnets to EdgeConnect peers.
Up Action Description
Default Subnet Action This reverts whatever was the Down Action back to the normal
state. Examples:
Templates Overview
Use templates to manage and assign common configuration parameters to appliances.
CAUTION: After saving, templates are applied automatically and replace all settings on an
appliance with those configured in the template. Some templates support a MERGE option.
Refer to the Help for more information.
• Each template that appears under Active Templates includes a timestamp that indicates
the amount of time that has passed since it was last edited, and the most recently edited
templates appear at the top of each template section in the list.
• You can edit only a template that appears under Active Templates.
• Click Show All > to view available templates that are not part of the selected template
group.
• To add a template to Active Templates, double-click it or drag it from Available Templates.
• To copy and save the current Active Templates as a new template group, click Save As.
Modifying a Template
1. Click a template under Active Templates to modify it.
The template has a timestamp that indicates when it was last modified, the user who
made the changes, and any comment (optional) that was entered by the user who made
the changes. The timestamp appears in the format “DD-MMM-YY HH:MM by [user] -
[optional comment text]” and the time is expressed in a 24-hour format.
2. To save the changes you made, click Save. The Save Template Changes dialog box opens.
3. Enter a comment (optional) in the Audit Log Comment field, and then click Save Tem-
plate Changes. Any text entered in the Audit Log Comment field appears on the tem-
plate timestamp and the Audit Logs tab.
NOTE: If the text of a timestamp comment is truncated, hover your cursor over the timestamp
to display the full text of the comment.
Template Groups
A Template Group contains one or more templates you can assign to some or all of the appli-
ances in your network.
• A timestamp for the selected template group appears below the template group drop-
down list and it indicates when one of the templates in the template group was last
modified. The timestamp appears in the format “DD-MMM-YY HH:MM” and the time is
expressed in a 24-hour format.
• To create a template group, click +Add below the template group drop-down list.
– To save changes you made to the new template group, click Save. The Save Tem-
plate Changes dialog box opens. Enter a comment (optional) in the Audit Log Com-
ment field, and then click Save Template Changes. Any text entered in the Audit
Log Comment field appears on the template timestamp and the Audit Logs tab.
• To delete the selected template group, click -Delete below the template group drop-
down list.
• When you apply a template group to an appliance, Orchestrator automatically keeps the
templates in the group in sync with the appliance.
• To apply template groups, click Apply Template Groups at the bottom of the page. This
will bring you to the Apply Templates tab where you can permanently associate appli-
ances with specific template groups.
• When returning to the Templates page, Orchestrator displays the last template group
viewed.
System Template
Use this template to configure system-level features.
Optimization
Field Description
fail-stick – When the failed tunnel comes back up, the flows do
not return to the original tunnel. They stay where they are.
fail-back – When the failed tunnel comes back up, the flows
return to the original tunnel.
disable – When the original tunnel fails, the flows are not
routed to another tunnel.
Network Memory
Field Description
Encrypt data on disk Enables encryption of all the cached data on the disks. Disabling
this option is not recommended.
Field Description
Excess flow policy Specifies what happens to flows when the appliance reaches its
maximum capacity for optimizing flows. The default is to bypass
flows. Or, you can choose to drop the packets.
Miscellaneous
Field Description
SSL optimization for non-IPSec tunnels Specifies whether the appliance should perform
SSL optimization when the outbound tunnel for
SSL packets is not encrypted (for example, a
GRE or UDP tunnel). To enable Network
Memory for encrypted SSL-based applications,
you must provision server certificates by using
the Orchestrator. This activity can apply to the
entire distributed network of EdgeConnect
appliances or just to a specified group of
appliances.
Bridge loop test Only valid for virtual appliances. When enabled,
the appliance can detect bridge loops. If it
detects a loop, the appliance stops forwarding
traffic and raises an alarm. Appliance alarms
include recommended actions.
Always send pass-through traffic to If the tunnel goes down when using WCCP and
original sender PBR, traffic that was intended for the tunnel is
sent back the way it came.
Enable default DNS lookup Enables the default DNS server to be included
with other configured DNS servers for
associating cloud portal domain names to
network IP addresses.
Enable HTTP/HTTPS snooping Enables a more granular application
classification of HTTP/HTTPS traffic by
inspection of the HTTP/HTTPS header, Host.
This is enabled by default.
Field Description
Quiescent tunnel keep alive time Specifies the rate at which to send keep alive
packets after a tunnel has become idle
(quiescent mode). The default is 60 seconds.
UDP flow timeout Specifies how long to keep the UDP session
open after traffic stops flowing. The default is
120 seconds (2 minutes).
Non-accelerated TCP flow timeout Specifies how long to keep the TCP session
open after traffic stops flowing. The default is
1800 seconds (30 minutes).
Maximum TCP MSS Maximum Segment Size. The default value is
1328 bytes. This setting ensures that packets
larger than the actual maximum transmission
unit (MTU) are not dropped if fragmentation is
not possible.
Field Description
• Stateful-SNAT exceptions apply only to appliances with firewall mode set to “State-
ful+SNAT”.
• Exceptions apply only to outbound flows destined to external addresses.
• Inbound flows initiated from the WAN side toward IP addresses within the address group
rely on existing inbound port-forwarding functionality.
• SNAT exceptions apply to the default segment only, not VRF SNAT.
• This feature does not support IPv6 because the address groups feature does not support
IPv6.
You can use the System template to set up Stateful-SNAT exceptions for all appliances or the
System Information dialog box for individual appliances. To set up exceptions for individual
appliances, see System Information.
To set up Stateful-SNAT exceptions for all appliances:
1. Create an address group for all public IP space (subnets) used by your network across all
branches, as follows:
1. Navigate to Configuration > Templates & Policies > ACLs > Address Groups.
The Address Groups tab opens.
2. Click Add Group.
The Add Address Group dialog box opens.
3. In the Group name field, enter an appropriate name for the Stateful-SNAT excep-
tions (for example, Stateful-SNAT-Exceptions).
4. In the IPs to include and IPs to exclude fields, enter IP addresses/masks to in-
clude/exclude individually or IP prefixes to include/exclude multiple addresses at
once, as appropriate. Use commas to separate entries.
5. If desired, use the Comment field to state the purpose of this address group.
6. Click Add.
2. In the System template’s Stateful-SNAT Exceptions field, enter the name of the address
group you created for Stateful-SNAT exceptions.
Auth/Radius/TACACS+ Template
EdgeConnect appliances support user authentication and authorization as a condition of
providing access rights.
• Authentication is the process of validating that the end user, or a device, is who they
claim to be.
• Authorization is the action of determining what a user is allowed to do. Generally, au-
thentication precedes authorization.
• Map order refers to the order in which the authorization servers are queried.
• The configuration specified for authentication and authorization applies globally to all
users accessing that appliance.
• If a logged-in user is inactive for an interval that exceeds the inactivity time-out, the ap-
pliance logs them out and returns them to the login page. You can change that value, as
well as the maximum number of sessions, in the Session Management template.
• The admin group supports full privileges, along with permission to add, modify, and
delete. This is equivalent to the Command Line Interface’s (CLI) __*configuration__*
mode privileges.
RADIUS
• RADIUS uses UDP as its transport.
• With RADIUS, the authentication and authorization functions are coupled together.
• RADIUS authentication requests must be accompanied by a shared secret. The shared
secret must be the same as defined in the RADIUS setup. Refer to your RADIUS docu-
mentation for details.
• IMPORTANT: Configure your RADIUS server’s __*priv levels__* within the following
ranges:
– admin = 7 - 15
– monitor = 1 - 6
TACACS+
• TACACS+ uses TCP as its transport.
• TACACS+ provides separated authentication, authorization, and accounting services.
• Transactions between the TACACS+ client and TACACS+ servers are also authenticated
through the use of a shared secret. Refer to your TACACS+ documentation for details.
• IMPORTANT: Configure your TACACS+ server’s roles to be admin and monitor.
What Is Recommended
• Use either RADIUS or TACACS+, but not both.
• For Authentication Order, configure the following:
1. Click Add to add a new 802.1x authentication profile or click the pencil icon to edit an
existing 802.1x profile.
The Add 802.1x Authentication Profile dialog box opens.
NOTE: To delete a profile listed in the table on the Network Access Control (NAC) dialog
box, click the corresponding delete icon (X) in the last column.
Field Description
3. Click Add.
1. Click Add to add a new MAC authentication profile or click the pencil icon to edit an
existing MAC authentication profile.
NOTE: To delete a profile listed in the table on the Network Access Control (NAC) dialog
box, click the corresponding delete icon (X) in the last column.
2. Complete the following fields:
Field Description
Field Description
3. Click Add.
Navigate to the Server tab to configure the servers and server groups you want to use to
authenticate the supplicants.
Server
Use the Server tab to add or edit the servers and server groups you want to use to authenticate
the supplicants attempting to log in to the network.
Servers Fields
Field Description
Field Description
Navigate to the AAA Profile tab to add or edit AAA profiles. AAA profiles define the authenti-
cation profile and server and server groups you want to use to authenticate supplicants.
Server Group Fields
You can create groups of servers. If one server is not reachable based on the server retry
count configured on the 802.1x/MAC tab, the appliance will switch to another server.
NOTE: To modify an existing server group, modify the existing data and click Save. To delete
a server group, click the corresponding delete icon (X) in the last column.
Field Description
Navigate to the AAA Profile tab to add or edit AAA profiles used to authenticate supplicants.
AAA profiles define the authentication profile and server and server groups you want to use
to authenticate supplicants.
AAA Profile
Use the AAA Profile tab to create profiles to map the 802.1x and MAC authentication profile to
a server group you want to use to authenticate supplicants. This profile is used for dynamic
authorization. For example, when a supplicant needs to be reauthenticated or the when the
existing session is disconnected. After you create a AAA profile, you will assign that profile to
an interface label.
You can edit an existing AAA profile or add a new AAA profile.
1. Click Add to add a AAA profile or click the pencil icon to edit an existing AAA profile.
The Add or Edit AAA Profile dialog box opens.
2. Complete the following fields:
Field Description
3. Click Add.
Apply Policies
Use the Apply Policies tab to modify the policies that are assigned to each interface label.
Supplicants plugged into the LAN port with the assigned interface label will be authenticated
using the policy you select.
Each LAN interface label defined in your Orchestrator deployment is assigned the default au-
thentication policy. The default authentication policy is set to “trusted.” When authentication
is set to “trusted”, no authentication is required to access the network.
Delete a Policy
To delete a policy from an LAN interface, click the corresponding delete icon (X) in the last
column. The NAC security settings for this LAN interface will return to the default values.
Merge / Replace
At the top of the page, choose:
Merge to use the values in the template, but keep any values set on the appliance as is (pro-
ducing a mix of template and appliance rules),
-OR-
Replace (recommended) to replace all values with those in the template.
• The appliance exports flows against two virtual interfaces—sp_lan and sp_wan—that
accumulate the total of LAN–side and WAN–side traffic, regardless of physical interface.
• These interfaces appear in SNMP and are, therefore, “discoverable” by NetFlow and IPFIX
collectors.
• For more information about Custom Information Elements, see Flow Export Tab.
• Enable Flow Exporting allows the appliance to export the data to collectors (and makes
the configuration fields accessible).
• The Collector’s IP Address is the IP address of the device to which you are exporting the
NetFlow/IPFIX statistics. The default Collector Port is 2055.
• In Traffic Type, you can select as many of the traffic types as you want. The default is
WAN TX.
• Click the Anonymize IPs check box to enable anonymizing IP addresses in log messages.
If enabled, select an option from the Bit Masking drop-down menu to indicate how IP
addresses have bit masking applied in log messages.
Field Description
Data aggregation The technique used for data aggregation. The default is percentile
method and there are currently no other options.
Data aggregation Indicates what percentage of the sample data is used to determine
limit baseline values. The default setting is 95%, which means the top 5%
of the sample is discarded and the other 95% is considered when
computing the baselines. You can enter a value between 75-100%.
Computation The time that passes before the system computes new baselines.
interval The default is 8 hours. For example, when using the default, the
baselines are computed every 8 hours using the latest sample data
collected during the Model training interval. This can be configured
in 4-hour units (e.g., 4, 8, 12, and so on) up to 240 hours.
Model training During this period, data is collected for various metrics every five
interval minutes and is aggregated into a data file. This data is used to
compute the baselines. The default is 14 days, the minimum is 7
days, and the maximum is 56 days.
NOTE: This period should include a diverse set of data that covers
various types of legitimate traffic and captures the characteristics
that distinguish normal traffic from malicious traffic during an attack.
Baseline upper limit The upper limit for the minimum baseline. An alarm is raised when
this value is reached. This setting is useful if Auto rate limit is
configured without Smart burst. The setting is a percentage of the
maximum baseline value, which is set manually. The default is 90%.
You can enter a value between 50-100%.
TCP inactivity Inactivity timeout used for TCP flows created using burst support
timeout levels. Inactive flow gets deleted after this timeout. The default is
300 seconds. You can enter a value between 30-1800 seconds.
Headroom for The percentage of headroom that is added to the baseline. The
baseline plus default is 20%. You can enter a value between 5-100%.
Per-source limit for The committed burst for a zone is available to all sources in the
committed burst zone. This determines the percentage of committed burst in a zone
that one source can use. The default is 50%. You can enter a value
between 1-50%.
Reserve flow Spare flow capacity is distributed among all zones by Smart burst
capacity using different methods (Proportional or Equal). The default
distribution method is Proportional.
Field Description
Excess burst credit On a per second basis, the zone is supposed to use a portion of
interval committed burst capacity. Unused committed burst capacity of
zones is made available as excess burst capacity every second. After
this interval of time, unused excess burst capacity goes back to the
respective committed burst. The default is 30 seconds. Enter a value
between 30-100 seconds.
Minimum reserve The minimum amount of reserve flow capacity that should be
capacity limit available before Smart burst redistributes new reserve capacity after
a baseline computation interval. Smart burst continues with
previously distributed capacities if the minimum reserve capacity
limit is not available. The default is 20%. You can enter a value
between 10-50%.
4. Click OK.
Field Description
Allowlist Enter an existing Address Group. Any IP address contained within the
Address Group will be exempt from DoS threshold analysis. The Allowlist
does not exempt flows from the options shown in the Security Settings
section.
Blocklist Enter an existing Address Group to explicitly block any IP address contained
within the configured Address Group.
6. (Optional) Click Show advanced settings and set the following fields:
Field Description
Rapid Set a threshold value (in seconds) to enforce the tearing down of TCP
aging connections when the period of inactivity matches the configured value (for
example, 30s).
Block Enforce dynamic blocking of flows originating from a source for a specified
duration duration (for example, 300s).
Embryonic Set this value so that the firewall can tear down half-open TCP connections
timeout when the timeout value is reached (for example, 30s). While TCP connection
goes through the three-way handshake (SYN, ACK, SYN-ACK), an embryonic
connection is a half-open connection that produces (for example) a SYN
without the other two parts of the handshake. This is a popular form of
denial of service (DoS) attack.
Share Select this check box to enable unused committed burst to be shared with
committed other zones. This check box is enabled by default. For critical zones, you can
burst disable this option, which retains the committed burst capacity for the zone
itself.
1. Either select a preset threshold from the DoS Thresholds drop-down list, or click Add
Custom Threshold.
The DoS Threshold dialog box opens.
2. Set the following parameters:
Field Description
Zone level: Flows originating from multiple endpoints that are part of a
single firewall zone.
Source level: All flows originating from a single endpoint or source device.
Metric DoS thresholds can be configured with any or all of the three metrics
available in a firewall protection profile:
Flows per second: Rate of flow (fps). A single flow is a unidirectional set of
packets containing common attributes (source and destination IP, ports,
protocols).
Concurrent Flows: Number of flows that are active at a given point in time.
Field Description
Max Label Select the method used to determine the max value:
3. Click OK.
5. Click Save.
Logging Template
Use this template to configure local and remote logging parameters. Each requires that you
specify the minimum severity level of event to log.
WARNING: Appliance logging levels should only be set to “Notice” unless TAC asks you to set it
differently. This applies to both the Minimum severity level field in the Log Configuration area
of this template and the Minimum Severity field in the Remote Log Receivers area. Be aware
that setting this level to “Debug” will generate logs for all modules that are turned on, which
causes the packet processing engine to spend excessive time logging instead of forwarding
packets.
• Set up local logging in the Log Configuration and Log Facilities Configuration sections.
– Click the Anonymize IPs check box to enable anonymizing IP addresses in log mes-
sages. If enabled, select an option from the Bit Masking drop-down menu to indi-
cate how IP addresses have bit masking applied in log messages.
– Click the Jsonify check box to convert log messages to JSON when exported.
– Uniquely assign log facilities for System, Audit, Firewall, and IDS/IPS Events; they
cannot overlap. For example, System can be assigned to local2 and Audit to local3,
but both cannot be assigned to local2.
• If NOTICE is selected (the default setting), the log records any event with a severity level
of NOTICE, WARNING, ERROR, CRITICAL, ALERT, and EMERGENCY.
• These are related to event logging levels, not alarm severities, even though some naming
conventions overlap. Events and alarms have different sources. Alarms, after they clear,
list as the ALERT level in the Event Log.
• In the Log Facilities Configuration section, assign each message/event type (System / Au-
dit / Firewall / IDS/IPS) to a syslog facility level (local0 to local7).
Field Description
Complete the instructions below for adding a client certificate using the
legacy method of uploading a certificate and key files.
You can add a client certificate in two ways. The recommended method is to use an orches-
trated appliance end entity profile. The legacy method is to upload a certificate and key files.
To add a client certificate using an appliance end entity profile:
To add a client certificate using the legacy method of uploading a certificate and key files:
Field Description
PFX Certificate To use a PFX certificate file, select this check box.
File
Certificate File Click Choose File. Locate and select the certificate file, and then click
Open.
Private Key File Click Choose File. Locate and select the private key file, and then click
Open. If you selected PFX Certificate File, this field is disabled.
Import Password Enter the import password for the certificate.
Passphrase Enter the passphrase for the certificate.
4. Click Add.
• End Entity Certificate: This is the recommended option. It automates certificate enroll-
ment using an EST server and globally orchestrated end entity profiles if the profile Pur-
pose is set to “TLS Server”.
• Custom Certificate: This is a legacy option. You install your own custom certificate from
a CA certificate authority.
• Self Signed Certificate: This is the default option. Browsers will not show this as secure,
and most IT departments will now allow this. If your enterprise intends to use the Edge-
Connect web UI directly, you need to use one of the other options.
1. Consult with your IT security team to generate a certificate signing request (CSR) and
submit it to your organization’s chosen SSL Certificate Authority (CA).
DNS Template
A Domain Name Server (DNS) stores the IP addresses with their associated domain names.
It enables you to reference locations by domain name, such as mycompany.com, instead of
using the routable IP address.
Date/Time Setting
Configure an appliance’s date and time manually, or complete the following steps to config-
ure it to use an NTP (Network Time Protocol) server.
1. From the Time Zone list, select the appliance’s geographical location.
2. If you select Manual, the appliance is matched to your web client system when the tem-
plate is applied. This eliminates the delay between configuring time manually and apply-
ing the template.
3. To use an NTP server, select NTP Time Synchronization and complete the following
steps.
1. Click Add.
2. Enter the IP address or host name of the server.
3. Select the version of NTP protocol to use.
NOTE: The server is selected in the order listed when you list more than one NTP server.
Data Collection
• Orchestrator collects and puts all statistics in its own database in Coordinated Universal
Time (UTC).
• When a user views statistics, the appliance (or Orchestrator server) returning the statis-
tics always presents the information relative to the browser time zone.
SNMP Template
EdgeConnect appliances support Management Information Base (MIB-II) as described in RFC
1213 for cold start traps, warm start traps, and EdgeConnect private MIBs. Appliances issue an
SNMP trap during reset when loading a new image, recovering from a crash, or rebooting.
An appliance sends a trap every time an alarm is raised or cleared. Traps contain additional
information about alarms, including severity, sequence number, a text-based description of
the alarm, and the time the alarm was created. For more information, you can download a
.zip archive containing supported MIBs here.
Use this page to configure the appliance’s SNMP agent and trap receivers.
1. Select the Enable SNMP check box to activate configuration options for SNMP v1/v2,
SNMP v3, and Trap Receivers details.
2. If you select the Enable SNMP Traps check box, the SNMP agent on the appliance sends
traps to configured receivers.
3. Use the Default Trap Community field to specify the string the trap receiver uses to
accept traps being sent to it. The default value is public. You can modify this value.
SNMP v1/v2
Field Description
Enable SNMP Allows the SNMP agent on the appliance to send traps to
configured receivers.
Read-Only The SNMP application needs to present this text string (secret) to
Community poll the appliance’s SNMP agent. The default value is public. You
can modify this value.
SNMP v3
For additional security, configure SNMP v3 if you want to authenticate without using clear
text. To add an SNMP v3 user, click Add above the SNMP v3 table and configure the following
properties:
Field Description
Enabled Select this check box to enable the selected user. Clear this
check box to disable the user and maintain the configuration.
Username Enter the username to identify the SNMP v3 user.
Authentication Type Select the authentication type to use for SNMP requests from
the user.
Field Description
Privacy Password Enter a password (key) to use for encrypting requests sent by
the user.
NOTE: To delete an SNMP v3 user, click the X to the right of the entry in the table.
Trap Receivers
To configure a trap receiver, click Add above the Trap Receivers table and configure the fol-
lowing properties:
NOTE: You can configure up to three trap receivers per appliance.
Field Description
For v3, specify the SNMP v3 user that is sending traps to the receiver.
Enabled Select this check box to enable the receiver. Clear this check box to
disable the receiver and maintain the configuration.
NOTE: To delete a receiver, click the X to the right of the entry in the table.
EdgeConnect provides deduplication for Secure Socket Layer (SSL) encrypted WAN traffic by
supporting the use of SSL certificates and other keys:
• EdgeConnect decrypts SSL data using the configured certificates and keys, optimizes the
data, and transmits data over an IPSec tunnel. The peer EdgeConnect appliance uses
configured SSL certificates to re-encrypt data before transmitting.
• Peers that exchange and optimize SSL traffic must use the same certificate and key.
• Use this template to provision a certificate and its associated key across multiple appli-
ances.
– You can add either a PFX certificate (generally, for Microsoft servers) or a PEM cer-
tificate.
– The default is PEM when PFX Certificate File is deselected.
– If the key file has an encrypted key, enter the passphrase needed to decrypt it.
– Configure the tunnels bilaterally for IPSec (or IPSec UDP) mode. To do so, access
the Configuration > Networking > Tunnels > Tunnels page, select the tunnel, and
for Mode, select IPSec.
– Verify that TCP acceleration and SSL acceleration are enabled. To do so, access
the Configuration > Templates & Policies > Optimization Policies page, and then
review the Set Actions.
• If you choose to be able to decrypt the flow, optimize it, and send it in the clear between
appliances, access the System template and select SSL optimization for non-IPSec tun-
nels.
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
– The appliance generates it locally, and each certificate is unique. This is an ideal
option for Proof of Concept (POC) and when compliance is not a big concern.
– To avoid browser warnings, follow up by importing the certificate into the browser
from the client-side appliance.
– If you already have a subordinate CA certificate (for example, an SSL proxy), you can
upload it to Orchestrator and push it out to the appliances. If you need a copy of it
later, just download it from here.
– If this substitute certificate is subordinate to a root CA certificate, also install the
higher-level SSL CA certificates (into the SSL CA Certificates template) so that the
browser can validate up the chain to the root CA.
– If you do not already have a subordinate CA certificate, you can access any appli-
ance’s Configuration > Templates & Policies > Applications & SaaS > SaaS Opti-
mization page and generate a Certificate Signing Request (CSR).
TIP: For a historical matrix of EdgeConnect and Orchestrator security algorithms, click here.
Tunnels Template
NOTE: If you are deploying an SD-WAN network, the Business Intent Overlays (BIOs) govern
tunnel properties. In this case, you do not need this template.
__*If you are not creating overlays__*, use this template to assign and manage tunnel proper-
ties.
• Tunnel templates can be applied to any appliances (with or without tunnels). However,
only existing tunnels can accept the template settings. To enable an appliance to apply
these same settings to future tunnels, select Make these the Defaults for New Tun-
nels.
• To view, edit, and delete tunnels, use the Tunnels tab. The Mode selected determines
the tabs that display.
Field Description
Field Description
Fastfail When multiple tunnels are carrying data between two appliances, this
Thresholds feature determines how quickly to disqualify a tunnel from carrying data.
The Fastfail connectivity detection algorithm for the wait time from receipt
of last packet before declaring a __*brownout__* is:
Base = 200mS
N = 2
Then,
RTTavg = 50mS
If set to disable, keepalives are sent every second, and 30 seconds elapse
before failover. In that time, all transmitted data is lost.
If set to enable, keepalives are sent every second, and a missed reply
increases the rate at which keepalives are sent from one per second to ten
per second. Failover occurs after one second.
Thresholds for Latency, Loss, or Jitter are checked once every second.
Field Description
VRRP Template
Use this template to distribute common parameters for appliances deployed with Virtual
Router Redundancy Protocol (VRRP).
VRRP specifies an election protocol that dynamically assigns responsibility for a virtual router
to one of the VRRP routers on a LAN. The VRRP router controlling the IP address(es) associated
with a virtual router is called the Master and forwards packets sent to these IP addresses. The
election process provides dynamic failover in the forwarding responsibility should the Master
become unavailable. This allows end hosts to use any virtual router IP addresses on the LAN
as the default first-hop router. The advantage gained from using VRRP is a higher availability
default path without configuring dynamic routing protocols such as BGP or OSPF.
Field Description
Field Description
Version Select the VRRP version that applies for your system:
• If a Peer Priority is not configured, the appliance randomly distributes flows among
multiple peers.
• The lower the number, the higher the peer’s priority.
NOTE: This feature requires appliance software 8.3.3.0 or higher for version 8 releases, and
requires 9.0.2.0 or higher for version 9 releases.
1. From the Redistribute Routes To drop-down list, select the appropriate target (direc-
tion of traffic) to which to redistribute your routes (SD-WAN Fabric, BGP Inbound, BGP
Outbound, or OSPF).
2. Select one of the following:
• Merge – Adds new maps to your existing maps. If the map already exists, the new
map matches appliance rules in the Orchestrator range. If the configured rules do
not match, the new map’s rules are appended to the existing rules.
• Replace – Replaces all existing maps with the new maps. It does not include rules
that match outside of the configured range.
Routes Template
Use the following settings to apply subnet sharing configuration to appliances associated with
this template group. Subnet sharing is the protocol used to exchange routes between Edge-
Connect appliances across the SD-WAN fabric.
• Automatically advertise local LAN subnets: The appliance will advertise LAN and vir-
tual interface subnets to SD-WAN fabric peers.
• Automatically advertised local WAN subnets: The appliance will advertise WAN inter-
face subnets to SD-WAN fabric peers.
Field Description
Field Description
Route map name to redistribute routes to Name of the route map being redistributed to
SD-WAN fabric the SD-WAN.
Include BGP local ASN to routes sent to Select Don’t apply, Yes, or No.
SD-WAN fabric
Filter routes from SD-WAN fabric with Select Don’t apply, Yes, or No.
matching local ASN
Tag BGP communities to routes Send the specified communities with routes
that are advertised to both SD-WAN fabric
peers and BGP peers, if the routes are learned
from any of the following source protocols:
Local/Static
SD-WAN (Local/Static)
SD-WAN (BGP)
SD-WAN (OSPF)
NOTE: If you select Don’t apply, Orchestrator ignores this field when applying this template
to appliances.
BGP Template
Use the BGP template to apply BGP configurations per segment to all appliances in the SD-
WAN fabric.
1. Under the Common settings for all segments header, complete the following fields:
Field Description
Max route updates per peer The maximum number of route updates for each peer
running route loop detection. The default value is 10, and
the range is 5–100.
Detection interval The interval, in minutes, at which route advertisement loop
detection runs. A route advertisement loop occurs when
the same route is being advertised, removed, and
re-advertised repeatedly within a short time period. The
default value is 15, and the range is 1–60.
2. Click the edit icon next to the segment for which you want to modify the configuration.
3. Configure the following elements as needed:
Field Description
AS Path Propagate Select Yes to enable this appliance to send the full AS path
associated with a prefix to other routers and appliances,
avoiding routing loops. This will provide the learned path
from an external prepend between a remote BGP site to local
BGP peers.
Graceful Restart Select Yes to enable receiver-side graceful restart capability.
EdgeConnect retains routes learned from the peer and
continues to use it for forwarding (if possible) if/when a BGP
peer goes down. Retained routes are considered stale
routes. They will be deleted and replaced when new routes
are received.
Max Restart Time If Graceful Restart is enabled, specifies the maximum time in
seconds to wait for a capable peer to come back after a
restart or peer session failure.
Stale Path Time If Graceful Restart is enabled, specifies the maximum time in
seconds following a peer restart before removing stale
routes associated with a peer.
Log BGP update messages Enable logging of BGP peer messages on the segment.
Next-Hop-Self Advertised route connected to a CE router that an
EdgeConnect appliance learns from a PE router.
Override ASN Indicates whether routes are advertised to the BGP peer
where the BGP peer’s own ASN is in the AS-Path.
Keep Alive Timer This is the interval, in seconds, between keep alive signals to
a peer.
Hold Timer When availability to a peer is lost, this value specifies how
long to wait before dropping the session.
Field Description
4. Click Update.
OSPF Template
Use the OSPF template to apply OSPF configurations per segment to all appliances in the SD-
WAN fabric.
1. Click the edit icon next to the segment for which you want to modify the configuration.
2. Configure the following elements as needed:
Field Description
Field Description
Route Map name to Redistribute Name of the route map being redistributed to the
routes to OSPF SD-WAN.
Field Description
3. Click Update.
BFD Template
Use the BFD template to apply BFD configurations per segment to all appliances in the SD-WAN
fabric, as follows:
1. Click the edit icon next to the segment for which you want to modify the configuration.
2. Configure the following fields:
Field Description
Field Description
3. Click Update.
VXLAN Template
Use the VXLAN template to to efficiently deploy Virtual Network Identifier (VNI) instances for
Virtual Extensible Local Area Network (VXLAN) segments. A VNI maps a routing segment to
a firewall zone and a fallback role. Each segment is identified by a 24-bit VNI that can be
configured for up to 16 million virtual networks. For additional information, see the VXLAN
tab
Prerequisites
Before you can assign a VNI to a VXLAN segment, you must configure the following settings:
• Segmentation must be enabled to support VXLAN. See the Routing Segmentation (VRF)
tab
• The IP routing on the BGP Layer 3 network that connects the EdgeConnect appliance
VTEPs must already be configured. This is necessary to enable VXLAN traffic to traverse
the network. Therefore, only in-line router mode is supported.
• Currently, the EdgeConnect EVPN address family is only supported for BGP EVPN peers
in the Default segment (VRF ID = 0).
• One or more loopback interfaces must already be available.
• VXLAN is only supported on LAN interfaces. Route-Targets must be defined, and BGP
enabled for all segments, even if no BGP peers are configured in non-default segments.
• Destination UDP Port: You can configure a custom destination UDP port for VXLAN. If
not selected, the appliance uses the default port of 4789.
• VTEP Source Interface: Select a loopback interface from the list.
NOTE: Only loopback interfaces are valid. The loopback interface you choose will auto-
matically be configured in the local interface field of the BGP Peer configuration if EVPN
Peer is enabled.
VNI Mappings
For this dialog box, use the steps belwo to map a VNI to a routing segment, a firewall zone,
and a fallback role.
Add
Edit
Note: In the Flows tab, enable the VNI Tx and VNI Rx columns to display the number of the
VNI that received or sent the VXLAN traffic. Both values should match for every flow. If not,
there might be a misconfiguration downstream from the EdgeConnect.
Field Description
Field Description
Subnet Shared - BGP Remote Route shared from an EdgeConnect peer in an external
network.
Subnet Shared - OSPF Route shared from an EdgeConnect peer within the same
Remote network.
BGP Branch (pre-8.1.9.4) Type of dynamic route learned from a local BGP branch
peer before version 8.1.9.4.
BGP Transit (pre-8.1.9.4) Type of dynamic route learned from a local BGP
branch-transit peer before version 8.1.9.4.
EBGP (post-8.1.9.4) External BGP: exchanging routing information with a router
outside the company-wide network after version 8.1.9.4.
Subnet Shared CFGSET ORO (Overlay Route Orchestrator) BGW (branch gateway)
(9.5.0.0+) route learned from the SD-WAN fabric.
Subnet Shared IAPVPN ORO Instant Access Point route learned from the SD-WAN
(9.5.0.0+) fabric.
Subnet Shared Overlay ORO modified/added route learned from the SD-WAN
(9.5.0.0+) fabric.
Subnet Shared RIP (9.5.0.0+) ORO learned Routing Information Protocol route learned
from the SD-WAN fabric.
OAP BGP (9.5.0.0+) Route learned from an OAP (Overlay Route Orchestrator)
BGP peer in an external network.
OAP CFGSET (9.5.0.0+) BGW (branch gateway) route learned from ORO.
OAP IAPVPN (9.5.0.0+) Instant Access Point route learned from ORO.
OAP OSPF (9.5.0.0+) Route learned from an OAP OSPF neighbor.
OAP Overlay (9.5.0.0+) ORO modified/added route.
OAP RIP (9.5.0.0+) Routing Information Protocol route learned from ORO.
OAP Static (9.5.0.0+) Static route learned from ORO.
OAP Direct (9.5.0.0+) Direct (connected) route learned from ORO.
BGP PE (pre-8.1.9.4) Type of dynamic route learned from a local BGP PE
(Provider Edge) router before version 8.1.9.4.
OSPF Route learned from an OSPF (Open Shortest Path First)
neighbor.
IBGP (post-8.1.9.4) Internal BGP: exchanging routing information with a router
inside the company-wide network after version 8.1.9.4.
• Deny prevents further processing of the flow by that ACL, specifically. The appliance
continues to the next entry in the policy.
• Permit allows the matching traffic flow to proceed on to the policy entry’s associated SET
actions. The default is permit.
• When creating ACL rules, list deny statements first, and prioritize less restrictive rules
ahead of more restrictive rules.
Priority
• For ACL rules, you can set the priority to a value within the range 1 to 65535. When
adding a rule, the priority is incremented by ten from the previous rule. You can change
the priority, but this default behavior helps ensure that you can insert new rules without
having to change subsequent priorities.
Match Criteria
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
Source or Destination
• An IP address can specify a subnet - for example: 10.10.10.0/24.
• To allow any IP address, use 0.0.0.0/0.
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
Why?
Each appliance’s default routing behavior is to auto-optimize all IP traffic, automatically direct-
ing flows to the appropriate tunnel. Auto-optimization strategies reduce the need to create
explicit route map entries for optimization. The three strategies provided are TCP-based auto-
opt, IP-based auto-opt, and subnet sharing. By default, all three are enabled on the System
template.
Priority
• With this template, you can create rules with a priority from 1000 – 9999. When the
template is applied to an appliance, Orchestrator will delete all rules having a priority in
that range before applying its policies.
• If you access an appliance directly, you can create rules with higher priority than Orches-
trator rules (1 – 999) and rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by ten from the previous rule. The pri-
ority can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• In the Destination field, you specify how to characterize the flow. The options are a
specific overlay, auto-optimized, pass-through [shaped], pass-through-unshaped, or
__drop__ped.
• When auto-optimized, a flow is directed to the appropriate tunnel. If you choose, you
can specify that the appliance use metrics to dynamically select the best path based on
one of these criteria:
– Load balancing
– Lowest loss
– Lowest latency
• When configuring the Route Policy for an individual appliance when multiple tunnels
exist to the remote peer, you can also select the path based on a preferred interface or
a specific tunnel.
Priority
• With this template, you can create rules with a priority from 1000 – 9999. When the
template is applied to an appliance, Orchestrator will delete all rules having a priority in
that range before applying its policies.
• If you access an appliance directly, you can create rules with higher priority than Orches-
trator rules (1 – 999) and rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by ten from the previous rule. The pri-
ority can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• The appliance encapsulates optimized traffic. This adds an IP outer header to packets
for travel across the WAN. This outer header contains the WAN QoS DSCP marking.
• LAN QoS – The DSCP marking applied to the IP header before encapsulation.
• WAN QoS – The DSCP marking in the encapsulating outer IP header. The remote appli-
ance removes the outer IP header.
• The appliance applies the QoS Policy’s DSCP markings to all pass-through flows—shaped
and unshaped.
• Pass-through traffic does not receive an additional header, so it is handled differently:
Priority
• With this template, you can create rules with a priority from 1000 – 9999. When the
template is applied to an appliance, Orchestrator will delete all rules having a priority in
that range before applying its policies.
• If you access an appliance directly, you can create rules with higher priority than Orches-
trator rules (1 – 999) and rules with lower priority (10000 – 19999 and 25000 – 65534).
NOTE: The priority range from 20000 to 24999 is reserved for Orchestrator.
• When adding a rule, the priority is incremented by ten from the previous rule. The pri-
ority can be changed, but this default behavior helps to ensure you can insert new rules
without having to change subsequent priorities.
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• An IP address can specify a subnet; for example, 10.10.10.0/24 (IPv4) or fe80::204:23ff:fed8:4ba2/64
(IPv6).
• To allow any IP address, use 0.0.0.0/0 (IPv4) or ::/0 (IPv6).
• Ports are available only for the protocols tcp, udp, and tcp/udp.
• To allow any port, use 0.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
NOTE: Slow LAN alert goes off when the loss has fallen below 80%
of the specified value configured in the TCP Accel Options
window.
CAUTION: Because changing these settings can affect service, it is recommended that you do
not modify these without direction from Support.
Option Description
Adjust MSS to Tunnel Limits the TCP MSS (Maximum Segment Size) advertised by the
MTU end hosts in the SYN segment to a value derived from the Tunnel
MTU (Maximum Transmission Unit). This is TCP MSS = Tunnel MTU
– Tunnel Packet Overhead.
A use case for disabling this feature is when the end host uses
Jumbo frames.
Auto Reset Flows NOTE: Whether this feature is enabled or not, the default
behavior when a tunnel goes Down is to automatically reset the
flows.
If enabled, it resets all TCP flows that are not accelerated, but
should be (based on policy and on internal criteria like a Tunnel
Up event).
Resetting
SYN packet was not seen (so this flow was either part of WCCP
redirection or it already existed when the appliance was inserted
in the data path).
Enable TCP SYN option Controls whether or not the proprietary TCP SYN option is
exchange forwarded on the LAN side. Enabled by default, this feature
detects if there are more than two EdgeConnect appliances in the
flow’s data path, and optimizes accordingly.
Option Description
End to End FIN This feature helps to fine tune TCP behavior during a connection’s
Handling graceful shutdown event. When this feature is ON (Default), TCP
on the local appliance synchronizes this graceful shutdown of the
local LAN side with the LAN side of the remote appliance. When
this feature is OFF (Default TCP), no such synchronization
happens and the two LAN segments at the ends gracefully shut
down, independently.
IP Block Listing If selected, and if the appliance does not receive a TCP SYN-ACK
from the remote end within five seconds, the flow proceeds
without acceleration and the destination IP address is blocked for
one minute.
Keep Alive Timer Allows changing the Keep Alive timer for the TCP connections.
First Timeout (Idle) – Time interval until the first Keep Alive
timeout.
LAN Side Window This setting allows the appliance to present an artificially lowered
Scale Factor Clamp Window Scale Factor (WSF) to the end host. This reduces the need
for memory in scenarios in which there are many out-of-order
packets being received from the LAN side. These out-of-order
packets cause much buffer utilization and maintenance.
Per-Flow Buffer (Max LAN to WAN Buffer and Max WAN to LAN Buffer)
Option Description
Route Policy Override Tries to override asymmetric route policy settings. It emulates
auto-opt behavior by using the same tunnel for the returning
SYN+ACK as it did for the original SYN packet.
When to NAT
Two use cases illustrate the need for NAT:
1. Inbound NAT. The appliance automatically creates a source NAT (Network Address
Translation) map when retrieving subnet information from the Cloud Portal. This
ensures that traffic destined to SaaS servers has a return path to the appliance from
which that traffic originated.
2. Outbound NAT. The appliance and server are in the cloud, and the server accesses the
internet. As in the example below, a Citrix thin client accesses its cloud-based server, and
the server accesses the internet.
For deployments in the cloud, best practice is to NAT all traffic—either inbound (WAN-to-
LAN) or outbound (LAN-to-WAN), depending on the direction of initiating request. This avoids
black-holing that can result from cloud-specific IP addressing requirements.
• Enabling NAT all applies NAT policies to pass-through traffic as well as optimized traf-
fic, ensuring that black-holing does not occur. NAT all on outbound only applies pass-
through traffic.
• If Fallback is enabled, the appliance moves to the next IP (if available) when ports are
exhausted on the current NAT IP.
In general, when applying NAT policies, configure separate WAN and LAN interfaces to ensure
that NAT works properly. You can do this by deploying the appliance in Router mode in-path
with two (or four) interfaces.
Advanced Settings
The appliance can perform source network address translation (Source NAT or SNAT) on
inbound or outbound traffic.
There are two types of NAT policies:
• Dynamic – Created automatically by the system for inbound NAT when the SaaS Opti-
mization feature is enabled and SaaS service(s) are selected for optimization. The appli-
ance polls the Cloud Intelligence Service for a directory of SaaS services, and NAT policies
are created for each of the subnets associated with selected SaaS service(s), ensuring that
traffic destined for servers in use by those SaaS services has a return path to the appli-
ance. Dynamic policy numbering assigns priority numbers (in the range 40000 to 50000)
to individual policies within a NAT map. The default (no-NAT) policy is numbered 65535.
• Manual – Created by the administrator for specific IP addresses / ranges or subnets.
When assigning priority numbers to individual policies within a NAT map, first view dy-
namic policies to ensure that the manual numbering scheme does not interfere with
dynamic policy numbering (that is, the manually assigned priority numbers cannot be in
the range 40000 to 50000). The default (no-NAT) policy is numbered 65535.
The NAT policy map has the following criteria and Set Actions:
Match Criteria
• These are universal across all policy maps—Route, QoS, Optimization, NAT (Network
Address Translation), and Security.
• If you expect to use the same match criteria in different maps, you can create an ACL
(Access Control List), which is a named, reusable set of rules. For efficiency, create them
in Configuration > Templates & Policies > ACLs > Access Lists, and apply them across
appliances.
• The available parameters are Application, Address Map (for sorting by country, IP ad-
dress owner, or SaaS application), Domain, Geo Location, Interface, Protocol, DSCP,
IP/Subnet, Port, Traffic Behavior Overlay, Fabric or Internet, and User Role (the User
Role as specified in the authentication exchange with the ClearPass RADIUS server).
NOTE: User Role options include the RADIUS User Role, User Name, User Group, User
Device, or User MAC. Configuring User Role match criteria enables an EdgeConnect to
automatically assign traffic steering and firewall zone policies.
• To specify different criteria for inbound versus outbound traffic, select the Source:Dest
check box.
NOTE: Source and destination role-based policies can be configured when both source
and destination users are in the same network.
Source or Destination
• Even when using a range or a wildcard, the IPv4 address must be specified in the 4-octet
format, separated by the dot notation. For example, A.B.C.D.
• Range is specified using a single dash. For example, 128-129.
• Wildcard is specified as an asterisk (____*).
• Range and Wildcard can both be used in the same address, but an octet can only contain
one or the other. For example, 10.136-137.*.64-95.
• A wildcard can only be used to define an entire octet. For example, 10.13*.*.64-95 is not
supported. Use 10.130-139.*.64-95 to specify this range.
• The same rules apply to IPv6 addressing.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
Set Actions
NAT Type
Option Description
NAT Direction
Option Description
NAT IP
Option Description
auto Select if you want to NAT all traffic. The appliance then picks the first
available NAT IP/Port.
tunnel Select if you want to NAT tunnel traffic only. Applicable only for inbound
NAT, as outbound does not support NAT on tunnel traffic.
[IP address] Select if you want to make NAT use this IP address during address
translation.
For Fallback, if the IP address is full, the appliance uses the next available IP address.
When you select a specific IP, ensure that the routing is in place for NAT-ted return traffic.
Merge / Replace
They alarm on both rising and falling threshold crossing events (that is, floor and ceiling levels).
For both levels, one value raises the alarm while another value clears it.
ON by Default
• Appliance Capacity – Triggers when an appliance reaches 95% of its total flow capacity.
It is not configurable and can be cleared only by an operator.
• File-system utilization – Percent of non-Network Memory disk space filled by the appli-
ance. This TCA cannot be disabled.
• Tunnel latency – Measured in milliseconds, the maximum latency of a one-second sam-
ple within a 60-second span.
OFF by Default
TCA Metrics
Times to Trigger – A value of 1 triggers an alarm on the first threshold crossing instance. The
default sampling granularity (or rate or interval) is one minute.
This table lists the metrics of each type of threshold crossing alert:
Metrics for Threshold Crossing Alerts
Appliance Level
WAN-side transmit kbps Minute averageWAN–side transmit TOTAL
throughput for all interfaces
LAN-side receive kbps Minute averageLAN–side receive TOTAL
throughput for all interfaces
Total number of flows End of minute count
optimized flows
Total number of flows flows End of minute count
File-system-utilization % (non–Network End of minute count
Memory)
Tunnel Level
Tunnel latency msec Second-sampled maximum latency during
the minute
Tunnel loss pre-FEC 1/10th % Minute average
Tunnel loss post-FEC 1/10th % Minute average
Tunnel OOP pre-POC 1/10th % Minute average
Tunnel OOP post-POC 1/10th % Minute average
Tunnel utilization % of configured Minute average
bandwidth
Tunnel reduction % Minute average
SaaS optimization requires three things to work in tandem: SSL (Secure Socket Layer), subnet
sharing, and Source NAT (Network Address Translation).
Enable SaaS optimization enables the appliance to contact the Cloud Intelligence Service and
download information about SaaS services.
• If Advertise is __*selected__* for a service (for example, SFDC), the appliance will:
• When Optimize is __*selected__* for a service (for example, SFDC), the appliance will:
* If its own RTT is lower, then the packet is sent pass-through (direct to the SaaS
server).
* If an advertised RTT it lower, then the packet is tunnelized.
– Generate a substitute certificate for an SFDC SSL domain (one sub cert per domain)
– No NAT rules created
• When Optimize is __*not selected__* for a service (for example, SFDC), the appliance:
– Receives subnet sharing advertisements for SFDC but does not use them
– Does no RTT calc pinging
– Does not participate in SSL
– Creates no NAT rules
– Sends all SFDC traffic as pass-through
The RTT Calculation Interval specifies how frequently Orchestrator recalculates the Round
Trip Time for the enabled Cloud applications.
The RTT Ping Interface specifies which interface to use to ping the enabled SaaS subnets for
Round Trip Times. The default interface is wan0.
TIPS
• Initially, you might want to set a higher RTT Threshold value so that you can see a
broader scope of reachable data centers/servers for any given SaaS application/service.
• If the Monitoring page shows no results at 50 ms, you might want to reposition your
SaaS gateway (advertising appliance) closer to the service.
• You can also assign a zone label to an Overlay. On a new system, all overlays are as-
signed the Default zone.
• Traffic between an Interface and an Overlay follows the same rules as traffic between
Interfaces or two Overlays; traffic is allowed between zones with the same label and any
traffic between different zones is dropped. Users can create Security Policies to allow
traffic between different zones.
Implicit Drop Logging enables you to configure implicit zone-based firewall drop logging levels.
Implicit zone-based firewall drop is for inter-zone traffic by default. For example, if all the
zone_x to zone_y traffic is the default Deny All (all the red cells from matrix), the traffic will be
dropped by the zone-based firewall engine.
Select one of the following levels for the Implicit Drop Logging from the list: None, Emergency,
Alert, Critical, Error, Warning, Notice, Info, or Debug.
NOTE: The default logging level is Alert.
Template
1. Create zone names in Configuration > Overlays & Security > Security > Firewall
Zones.
2. Create security policies to define exceptions.
To edit or add a rule, select the desired square in the matrix, and when the Edit Rules
pop-up appears, make the desired changes.
3. Select the edit icon in the Match Criteria column and the Match Criteria pop-up appears.
Make the desired changes.
4. You can select More Options to customize your rules. Select the check box next to the
specific match criteria and select your desired changes from the list.
5. Click Save.
• CIDR notation and (Range or Wildcard) are mutually exclusive in the same address. For
example, 192.168.0.1-127/24 is not supported. Use either 192.168.0.0/24 or 192.168.0.1-
127.
• These prefix-matching rules apply to the following policies only: Route, QoS, Optimiza-
tion, NAT, Security, and ACLs.
Shaper Template
The Shaper template provides a simplified way of globally configuring QoS (Quality of Service)
on your appliances. To view applied configurations, navigate to Configuration > Templates
& Policies > Shaping > Shaper.
A shaper is a set of policies that control access and traffic flow on the appliances by allocating
bandwidth as a percentage of the system bandwidth. Shaper parameters are organized into
ten traffic classes. Four traffic classes are preconfigured and named real-time, interactive,
default, and best effort. After compressing (deduplicating) all the outbound tunnelized and
pass-through-shaped traffic, the system either applies policy settings globally or upon each
interface, shaping traffic as it exits the interface.
Applying the template to an appliance updates its system-level wan shaper. If the appliance
has any added, interface-specific shapers, they are preserved. For minimum and maximum
bandwidth, you can configure traffic class values as a percentage of total available system
bandwidth and as an absolute value. The appliance always provides the larger of the minimum
values and limits bandwidth to the lower of the maximum values. You can rename or edit any
traffic class.
To view any applied configurations, access the Configuration Templates & Policies > Shap-
ing > Shaper page.
Shaper Options
Option Description
Inbound / Outbound Enables you to select the direction to which to apply shaper
configurations.
Option Description
Add Shaper If desired, you can add a shaper. However, because the
Total WAN shaper provided by Orchestrator is generally
sufficient, you should not need to add other shapers.
Delete Shaper Enables you to delete shapers you have explicitly added.
Enable shaping Indicates whether to enable shaping of traffic. Shaping is
always enabled for outbound traffic. Shaping for inbound
traffic is recommended and best practice, but optional.
Per interface Indicates whether to shape traffic on an individual interface
level. It is recommended and best practice to select this
option. Shaping is based on per-interface bandwidth and
total system bandwidth.
Recalc on IF and/or nexthop Indicates whether to recalculate shaper bandwidth based
reachability state change on the loss of any WAN-side interface or next-hop
reachability. It is recommended and best practice to select
this option.
Enable Dynamic Rate Indicates whether to enable Dynamic Rate Control (DRC).
Control This feature prevents many-to-one bandwidth
oversubscription. This option is available only for inbound
traffic. For more information, see Dynamic Rate Control
below.
Shaper Configuration
Field Description
Traffic Name Name assigned to the traffic class (by Orchestrator or the
user).
Priority Order in which to allocate each class’ minimum bandwidth.
Valid values are 1 to 10 with 1 as first priority and 10 as last.
Min Bandwidth % Minimum percentage of bandwidth guaranteed to the
traffic class, allocated by priority. However, if the sum of the
percentages is greater than 100%, lower-priority traffic
classes might not receive their guaranteed bandwidth if it is
all consumed by higher-priority traffic.
Field Description
To enable this feature, select the Inbound filter, and then select the Enable Dynamic Rate
Control check box on the Shaper template or the Shaper dialog box.
IMPORTANT: DRC is driven by QoS drops and shaper wait time. If you configure the EdgeCon-
nect with an Inbound Shaper value greater than or equal to the service provider, the EdgeCon-
nect will never see drops or wait time and your traffic will not receive the benefits of DRC.
CLI Template
Use this template to enter any sequence of Command Line Interface (CLI) commands.
Enter each CLI command on a new line.
Orchestrator sends all commands entered in the CLI template with a single batch command
to EdgeConnect gateway. This batch command is sent through a single REST call that has a
60 second timeout. Placing enough commands to cause the REST call to timeout can result in
unpredictable behavior.
CLI commands can be entered directly in the CLI to verify the time required to execute them.
We recommend that the command set entered in the CLI Template page requires a maximum
of 30 seconds when entered manually in the CLI.
Field Description
Auto Logout Specifies the amount of time in minutes after which an inactive
session will be automatically logged out. The valid range is 0-60.
Use 0 to disable automatic logout.
Field Description
The string can only contain the following characters: a-z, A-Z, 0-9,
and +-:.!_@
• Drag templates up or down to reorder the list. Orchestrator automatically applies any
changes to templates to their associated appliances.
NOTE: If multiple template groups are applied to an appliance, the order in which they are
applied determines which template is used. Templates applied later (lower on the apply order
list) overwrite any conflicting templates applied earlier.
NOTE: “Remove” is recommended over “Merge” to ensure that appliance settings remain uni-
form across all appliances receiving the template changes.
• The following table is an example of “Merge” behavior. The newly applied template’s
settings override all old settings (aclMap 1, 2 and 4) but where the new template does
not have specific settings, the previous settings remain (aclMap3).
• Navigate to the Identity and Access Management (IAM) under Services to create a user
profile with permissions for Orchestrator.
• Navigate to the Virtual Private Cloud (VPC) Dashboard and configure your Transit Gate-
ways for the regions you want.
• Navigate to Network Manager from the VPC Dashboard under Transit Gateways to
create a Global Network.
• Associate your Transit Gateways to the Global Network.
1. Sign in to AWS and navigate to the Identity and Access Management (IAM) service
from the main AWS Management Console (Services > Security, Identity, & Compliance
> IAM).
• Adding a user to your group – The user will inherit the permissions assigned to the
group.
8. Assign optional tags for your user. If you choose to add a tag, complete these steps:
9. Select Next: Review. This page displays the review of the profile you just created for
your user. The User Details, Permissions Summary, and additional information such
as tag, are shown.
10. Select Create User. The page should now show the following success message, along
with Access Key ID and the Secret Access Key associated with your configured user.
Copy and paste the Access Key ID and the Secret Access Key to a secure place for later
use. You will need these when adding the AWS account on Orchestrator.
Next, you must create Transit Gateways (or select existing Transit Gateways you have already
created) to associate with your AWS Network Manager, which you create in the steps below.
Transit Gateways will terminate the Site-to-Site IPSec tunnels established from the EdgeCon-
nect appliances in your network.
To create a new Transit Gateway, complete the following steps:
1. Navigate to the Virtual Private Cloud (VPC) Dashboard (Services > Networking & Con-
tent Delivery).
2. Click Transit Gateways, under Transit Gateways in the left menu.
3. Click Create Transit Gateways.
Field Description
Field Description
VPN ECMP support Select this check box if you want to enable Equal Cost
Multi-Path routing support in your Transit Gateways. This
allows traffic with the same source and destination to be
sent across the same multiple paths.
Default Route Table Select this check box if you want to automatically associate
Association other Transit Gateways to the route table that this one is
using.
Default Route Propagation Select this check box if you want to automatically create
other Transit Gateways with this same route table.
Auto-accept shared Select this check box if you want your transit gateways to
attachments automatically accept attachments associated with
different accounts.
5. Click Create Transit Gateway. A success message should display along with your Transit
Gateway ID.
After you create your Transit Gateway, you must create a Global Network in AWS. A Global
Network hosts your specified Transit Gateways. It is managed by the AWS Network Manager.
Orchestrator Configuration
After completing the AWS prerequisites, navigate to the AWS Network Manager tab in Or-
chestrator. There are seven buttons above the table on this tab that you use to complete
the AWS and Orchestrator integration: Subscription, Interface Labels, Tunnel Settings, VTI
Subnet Pool, Segment & Zone Association, AWS Resources, and Appliance Association.
Subscription
Field Description
4. Click Save.
You now should have an established connection with Orchestrator to your AWS account.
Interface Labels
The Build Tunnels Using These Interfaces dialog box enables you to select the interfaces to
build your tunnels to AWS.
1. Click the Interface Labels button. The Build Tunnels Using These Interfaces dialog box
opens.
2. Drag the interface labels you want to apply from the column on the right into the Primary
columns.
3. Click Save.
Tunnel Settings
The Tunnel Settings dialog box shows IKE and IPSec parameters used by Orchestrator when
building Site-to-Site IPSec tunnels from the EdgeConnect appliances to the Transit Gateways.
No changes are necessary for these parameters.
In this dialog box, set the Subnet IP address and the mask for the AWS subnet pool. Enter the
subnet IP address and the mask ID in the designated fields.
NOTE: This is an AWS-specific subnet pool. Therefore, every subnet IP address must start with
169.254 to be included in this pool.
You can apply configured segments to your VTI interfaces associated for AWS. Click the Zone
icon and select the zone you want to apply from the drop-down list.
AWS Resources
Appliance Association
In this dialog box, you can choose which Transit Gateways you want to associate with your
EdgeConnect appliances.
NOTE: You must first select the EdgeConnect appliances on the Orchestrator appliance tree,
and then open the Network Manager Association tab to associate the appliances to your Tran-
sit Gateways.
1. Select or clear the check box next to the appliance you want to connect to or disconnect
from the Network Manager.
2. See the following table for field descriptions.
Field Description
3. Click Save.
Orchestrator starts to establish the Site-to-Site IPSec tunnels from the EdgeConnect ap-
pliances to the selected Transit Gateways.
Verification
You can verify the stability and connectivity of your tunnels to the AWS Network Manager using
the Connection Status column on the AWS Network Manager tab. This column shows the BGP
Peer status. You can find additional details on the Tunnels, VTI, and BGP tabs.
Also, you can verify the AWS resources that Orchestrator created on the VPC Dashboard. To
view the resources on the VPC dashboard, navigate back to the Virtual Private Network sec-
tion in AWS and select Customer Gateways and Site-to-Site VPN Connections. On these
tabs, you can confirm that the IPSec tunnels you created in Orchestrator are functioning cor-
rectly.
The tunnels should be in the ‘available’ state.
After the tunnels and the BGP sessions are established, the TGW route table shows the routes
learned from the EdgeConnect devices. To create a route table for your transit gateways, nav-
igate to the VPC Dashboard in AWS and click Transit Gateway Route Tables under Transit
Gateways. To create a static route, select the transit gateway from the Route Table and navi-
gate to the Routes tab.
Complete the following fields, and then click Create Static Route.
Field Description
Peering
To begin sending traffic from the spoke VPCs where your AWS workloads are running, you
must peer the VPCs with the Transit Gateways. To peer your configured Transit Gateways,
navigate back to your VPC dashboard in AWS and click Transit Gateway Attachments under
Transit Gateways. Complete the following steps.
1. Select the check box next to the available transit gateways you want to peer.
2. Click Create Transit Gateway Attachment.
3. Choose the Transit Gateway ID from the drop-down menu.
4. For Attachment Type, select Peering Connection.
5. For Attachment Name Tag, enter text for identification purposes.
6. For Account, select the check box for My Account.
7. For Region, choose the destination region you want the BGP peering to connect with.
HPE SSE
Configuration > Cloud Services > HPE SSE
HPE Aruba Networking SSE is a cloud security service. EdgeConnect traffic can be service
chained to HPE SSE for additional security inspection. Orchestrator supports IPSec tunnel
mode for HPE SSE.
IMPORTANT: By default, the maximum limit is 100 tunnels per HPE SSE tenant. If you want to
increase the limit, you must contact HPE Aruba Networking support for assistance.
The following table describes the fields on the HPE SSE tab.
Field Description
Subscription
1. In Orchestrator, navigate to the HPE SSE tab (Configuration > Cloud Services > HPE
SSE).
2. Click Subscription.
The Subscription dialog box opens. Leave the dialog box open, so you can paste your
HPE SSE API token key in the API Token Key field.
3. In a new browser tab, go to https://auth.axissecurity.com/ and log in to your HPE SSE
account.
4. From the Dashboard, click Settings and then click Admin API.
The Admin API page opens.
5. Click New API Token.
The New API Token dialog box opens.
6. Enter a Name for the new API token. The name should identify your Orchestrator.
Field Description
HPE SSE Indicates whether you are connected to your HPE SSE account.
API Token Name Enter the name you assigned to the API token you created in your
HPE SSE account.
NOTE: The name should match exactly what you entered in the
HPE SSE dashboard.
API Token Key Enter (paste) the API token you created in your HPE SSE account.
This token is used to access the HPE SSE APIs.
API Domain The domain name of the HPE SSE APIs that are used in tunnel
creation. Leave the default setting.
Tunnel Identifier A unique identifier for the tunnel that is used when building the
tunnel IKE identifiers. Enter the domain name for your company.
For example, arubanetworks.com.
Location Suffix A unique identifier for the Orchestrator instance. This is used to
distinguish between different Orchestrators and facilitates using
a single HPE SSE account for multiple Orchestrators.
15. Click Save. The HPE SSE field should indicate Connected.
Interface Labels
Select the WAN interfaces you want to use for HPE SSE internet traffic. You can specify primary
and backup interfaces as described below. If a primary interface is unavailable, Orchestrator
will use a backup interface if specified. Optionally, you can specify secondary interfaces as
well. In this case, the fallback order is primary, secondary, and then backup.
WARNING: This is service affecting. Any changes to the interface selection can cause previ-
ously built tunnels to be deleted and rebuilt.
Tunnel Settings
The Tunnel Settings button opens the HPE SSE Tunnel Setting dialog box, enabling you to
define the tunnels associated with HPE SSE and EdgeConnect. The Mode field on the General
tab allows you to select IPSec as the tunnel protocol for the specified WAN interface label. Use
HPE SSE defaults for tunnel settings defined by the system.
NOTE: You can configure General, IKE, and IPSec tunnel settings. Settings are automatically
generated, but you can change them if you want to.
IP SLA
Configure IP SLA for HPE SSE tunnels. This configuration ensures tunnel connectivity and in-
ternet availability between HPE SSE and Orchestrator. If the tunnel cannot reach HPE SSE, the
tunnel is considered DOWN.
IMPORTANT: You must configure a loopback interface and a unique LAN-side label (such as
“LOOPBACK”) for the orchestrated loopback interface before you can set up IP SLA for HPE SSE
tunnels. See Loopback Orchestration and Interface Labels for more information.
Sub-Locations
Sub-locations are a mechanism to configure and deploy different security policies to different
types of traffic, at scale. When configuring a sub-location, you specify a subnet range to which
the sub-location applies. Orchestrator then creates a corresponding sub-location in HPE SSE
using that subnet range, and EdgeConnect appliances automatically provision the sub-location
names.
From HPE SSE, you can apply policy rules to sub-locations. The policy rules are applied to all
appliances that are configured as part of a sub-location regardless of physical location.
5. In the Internal IPs field, do one of the following to specify the subnet range for the sub-
location:
• Enter the name of a configured LAN label, firewall zone, or address group.
• Enter an IP address or IP address range and click +Add.
6. Click Save.
The Sub-Location Match Criteria dialog box closes.
7. Click Save.
You can override the automatically selected endpoints for specific sites. You have the option
to add this exception to one or more sites within your network.
Field Description
3. Click Save.
The final step to configure the integration in Orchestrator is to associate EdgeConnect appli-
ances to HPE SSE.
1. In the Orchestrator appliance tree, select one or more appliances to associate with HPE
SSE.
2. On the HPE SSE tab, click HPE SSE Association.
The HPE SSE Appliance Association dialog box opens.
3. In the table, select one or more appliances you want to associate with HPE SSE, and then
select the Add check box.
Select the Remove check box to remove HPE SSE association from selected appliances
in the table.
4. Verify the changes, and then click Save.
Pause Orchestration
When troubleshooting, you can click Pause Orchestration and then click Save to pause or-
chestration. To restart, click Resume Orchestration.
1. Navigate to the Business Intent Overlays tab in Orchestrator (Configuration > Overlays
& Security > Business Intent Overlays).
2. Click the overlay that breaks out traffic to HPE SSE.
The Overlay Configuration dialog box opens.
3. Click the Breakout Traffic to Internet & Cloud Services tab.
4. Drag HPE SSE Cloud from the Available Policies column to the Preferred Policy Order
column.
• Subscription ID
• Tenant (Directory) ID
• Application (Client) ID
• Client Secret Key
Orchestrator Prerequisites
Complete the following tasks in Orchestrator:
Orchestrator Configuration
When are you finished with the Azure and Orchestrator prerequisites, navigate to the Mi-
crosoft Azure Virtual WAN tab in Orchestrator. There are five buttons at the top of the table
that are used to complete the Azure and Orchestrator integration: Subscription, Interface
Labels, Virtual Wan Association, Tunnel Settings, and Zone.
To begin, click the Subscription icon.
Subscription
1. Enter the information in the Subscription fields that reflect your Azure portal account.
2. Click Save after you have finished entering the information in the table below. The Azure
field should reflect Connected.
The following table represents the values in the Subscription window from the Azure portal.
Field Description
Field Description
*Storage URL
The Storage URL is present on the Storage Accounts tab in your Azure portal. Complete the
following steps to obtain your storage account URL.
Interface Labels
Select the order in which you want your interface labels to be used.
1. Click the Interface Labels button. The Build Tunnels Using These Interfaces displays.
2. Drag the Interface labels you want to use into the Preferred Interface Label Order
column.
3. Click Save.
Tunnel Settings
The Tunnel Settings button opens the Tunnel Settings dialog box, which enables you to de-
fine the tunnels associated with Azure and Orchestrator. It is recommended that you use the
default tunnel settings for General, IKE, and IPSec; however, you can modify any field. The
tunnel settings are set using the default VPN configuration parameters received from virtual
WAN APIs located in your Azure portal account.
In your Azure Portal Account, navigate to the Azure Configuration table. This table displays the
VPN site created for Orchestrator appliances associated to Azure virtual WANs. Additionally,
manually associate sites to your hubs in Azure.
Zone
You can apply configured segments to your VTI interfaces associated for Azure. Click the Zone
button and select the zone from the drop-down you want to apply.
Verification
The Tunnel page displays that Azure and Orchestrator have an established connection with
Azure by displaying a tunnel status of up - active.
For more information about Azure configuration, visit the following link: https://docs.microso
ft.com/en-us/azure/virtual-wan/virtual-wan-site-to-site-portal.
Default For everything Any policy order except Matches Microsoft Office
“Drop” 365 Default categories
Office365 Common
applications
For more information about applications that work with Office 365, go to Microsoft 365 &
Security for Partners.
Field Description
Field Description
Configure Zscaler
Before you configure Zscaler, you must create a Zscaler account and ensure that you have an
established connection with Zscaler.
NOTE: Ensure that both IPSec and GRE services are enabled in your Zscaler subscription so
that Orchestrator can download data appropriately from Zscaler.
NOTE: This section represents the automated configuration of IPSec, IKE, and GRE tunnels
from EdgeConnect to the Zscaler cloud. To manually configure the tunnels with the Zscaler
cloud, refer to the EdgeConnect and Zscaler IPSec Integration Guide and the EdgeConnect and
Zscaler GRE Integration Guide.
Subscription
Field Description
Interface Labels
Select the WAN interfaces you want to use for Zscaler internet traffic. You can specify primary
and backup interfaces as described below. If a primary interface is unavailable, Orchestrator
will use a backup interface if specified. Optionally, you can specify secondary interfaces as
well. In this case, the fallback order is primary, secondary, and then backup.
The Build Zscaler Tunnels Using These Interfaces dialog box opens.
2. Drag the interfaces you want to use from the right side of the dialog box to the Primary
and Backup areas. The interfaces are grayed out until you move them into the areas.
3. If you want to specify secondary interfaces, click Show Secondary to display the Sec-
ondary area, and then drag the appropriate interfaces to this area.
4. Click Save.
WARNING: This is service affecting. Any changes to the interface selection can cause previ-
ously built tunnels to be deleted and rebuilt.
Tunnel Settings
The Tunnel Settings button opens the Zscaler Tunnel Setting dialog box, enabling you to de-
fine the tunnels associated with Zscaler and EdgeConnect. The Mode field on the General tab
allows you to select IPSec or GRE as the tunnel protocol for the specified WAN interface label.
Use Zscaler defaults for tunnel settings defined by the system.
NOTE: For IPSec mode, you can configure General, IKE, and IPSec tunnel settings. For GRE
mode, you can configure General tunnel settings. Settings are automatically generated, but
you can change them if you want to.
You can override the automatically selected Service Edge pair for specific sites. You have the
option to add this exception to one or more sites within your network.
NOTE: Orchestrator does not support Service Edge Override for GRE tunnels.
Field Description
3. Click Save.
IP SLA
Configure IP SLA for Zscaler tunnels. This configuration ensures tunnel connectivity and in-
ternet availability between Zscaler and Orchestrator. If the tunnel cannot reach Zscaler, the
tunnel is considered DOWN.
Field Description
4. Accept the default values for the remaining fields and click Save.
Orchestrator builds the tunnels.
Country / Timezone
You can use the Zscaler Country / Timezone dialog box to configure standard ISO Country
Codes to Zscaler Country Enums and standard Time Zones to Zscaler Time Zone Enums. On
the Zscaler Internet Access tab, click Country / Timezone to open the dialog box. Make
changes, and then click Save.
NOTE: If the Zscaler VPN Location request fails with an invalid request body, you can use this
dialog box to change the ISO Country Code to the correct Zscaler Country Enums. The Zscaler
enum list is available in the Zscaler documentation and this Zscaler Trust post.
Gateway Options
You can configure gateway options and rules for Zscaler sub-locations. Orchestrator uses
location and sub-locations to better define a branch site in the Zscaler cloud. Sub-locations
are LAN-side segments within each branch. They can be identified by LAN interfaces, zones,
or a collection of LAN subnets.
Enable Gateway Options
To enable gateway options:
7. Click Save.
NOTE: Sub-locations can be applied to all WAN links selected in the Build Tunnels Us-
ing These Interfaces dialog box (accessed by clicking the Interface Label button on the
Zscaaler Internet Access tab).
If you select the Show sub-locations check box on the Zscaler Internet Access tab, the sub-
locations configured in Gateway Options appear in the Zscaler table.
Configure Bandwidth Control
You can set up bandwidth controls for your Zscaler sub-locations configured in Gateway Op-
tions. Select from bandwidth control options that use fixed amounts of bandwidth, inherit
bandwidth values from parent locations, or use percentages of deployment bandwidth.
4. Click Save.
The Change Gateway Options dialog box opens.
WARNING: Changing Gateway Options is service affecting. Make changes during a main-
tenance window.
5. Click Change Gateway Options.
Your changes are applied to Orchestrator and Zscaler. This process takes time to com-
plete.
Zscaler Association
The final step to configure the integration in Orchestrator is to associate EdgeConnect appli-
ances to Zscaler.
1. In the Orchestrator appliance tree, select one or more appliances to associate with Zs-
caler.
2. On the Zscaler Internet Access tab, click Zscaler Association.
The Zscaler Appliance Association dialog box opens.
3. In the table, select one or more appliances you want to associate with Zscaler, and then
select the Add check box.
Select the Remove check box to remove Zscaler association from selected appliances in
the table.
4. Verify the changes, and then click Save.
Pause Orchestration
When troubleshooting, you can click Pause Orchestration and then click Save to pause or-
chestration. To restart, click Resume Orchestration.
1. Navigate to the Business Intent Overlays tab in Orchestrator (Configuration > Overlays
& Security > Business Intent Overlays).
2. Click the overlay that breaks out traffic to Zscaler.
The Overlay Configuration dialog box opens.
3. Click the Breakout Traffic to Internet & Cloud Services tab.
4. Drag Zscaler Cloud from the Available Policies column to the Preferred Policy Order
column.
Netskope
Configuration > Cloud Services > Netskope
Netskope is a cloud security service. EdgeConnect traffic can be chained to Netskope for ad-
ditional security inspection. Orchestrator supports IPSec tunnel mode for Netskope.
NOTE: Be aware that design changes that occur in the Netskope application (especially the
user interface) could affect instructions provided in this topic. Therefore, these instructions
are provided as guidelines rather than precise steps.
IMPORTANT: If you have Netskope running through Service Orchestration, you must take
down the manual tunnels before enabling the API through the Configuration > Cloud Services
> Netskope feature.
The following table describes the fields on the Netskope tab.
Field Description
Field Description
Configure Netskope
Before you configure Netskope, you must create a Netskope account and ensure that you
have an established connection with Netskope.
Subscription
Endpoint Privileges
/api/v2/steering/ipsec/pops Read
/api/v2/steering/ipsec/tunnels Read + Write
2. After configuring your Netskope account, navigate to Configuration > Cloud Services >
Netskope.
3. Click Subscription.
The Subscription dialog box opens.
4. Enter the appropriate information to reflect your Netskope account.
The following table describes the fields.
Field Description
Interface Labels
Select the WAN interfaces you want to use for Netskope internet traffic. You can specify pri-
mary and backup interfaces as described below. If a primary interface is unavailable, Orches-
trator will use a backup interface if specified. Optionally, you can specify secondary interfaces
as well. In this case, the fallback order is primary, secondary, and then backup.
NOTE: When two or more labels are configured and active at the same level (primary, sec-
ondary, or backup) new flows will be load balanced across the Netskope tunnels based on
current available bandwidth for the label. Labels with more available bandwidth will receive
more flows than labels with less available bandwidth.
1. On the Netskope tab, click Interface Labels.
The Build Tunnels Using These Interfaces dialog box opens.
2. Drag the interfaces you want to use from the right side of the dialog box to the Primary
and Backup areas. The interfaces are grayed out until you move them into the areas.
3. If you want to specify secondary interfaces, click Show Secondary to display the Sec-
ondary area, and then drag the appropriate interfaces to this area.
4. Click Save.
WARNING: This is service affecting. Any changes to the interface selection can cause previ-
ously built tunnels to be deleted and rebuilt.
Tunnel Settings
The Tunnel Settings button opens the Netskope Tunnel Setting dialog box, enabling you to
define the tunnels associated with Netskope and EdgeConnect. Use Netskope defaults for
tunnel settings defined by the system.
NOTE: You can configure General, IKE, and IPSec tunnel settings. Settings are automatically
generated, but you can change them if you want to.
IP SLA
Configure IP SLA for Netskope tunnels. This configuration ensures tunnel connectivity and
internet availability between Netskope and Orchestrator. If the tunnel cannot reach Netskope,
the tunnel is considered DOWN.
1. On the Netskope tab, click IP SLA.
The Netskope IP SLA Configuration dialog box opens.
2. If all fields are dimmed, click Enable IP SLA rule orchestration.
3. Select an orchestrated loopback label from the Source Interface field.
Note: When IP SLA is enabled for Netskope, Orchestrator automatically sets the Monitor
field to Ping and uses the IP SLA targets specified by Netkope in the RESTv2 API response.
Each Netskope POP uses a unique IP SLA target. The auto-IP SLA target typically ends in
.216. For example, 10.162.6.216 (LON1) and 10.177.6.216 (LON2).
4. Accept the default values for the remaining fields and click Save.
Orchestrator builds the tunnels.
Netskope Association
The final step to configure the integration in Orchestrator is to associate EdgeConnect appli-
ances to Netskope.
1. In the Orchestrator appliance tree, select one or more appliances to associate with Net-
skope.
2. On the Netskope tab, click Netskope Association.
The Netskope Appliance Association dialog box opens.
3. In the table, select one or more appliances you want to associate with Netskope, and
then select the Add check box.
Select the Remove check box to remove Netskope association from selected appliances
in the table.
4. Verify the changes, and then click Save.
Pause Orchestration
When troubleshooting, you can click Pause Orchestration and then click Save to pause or-
chestration. To restart, click Resume Orchestration.
You can view the Audit Log to check for orchestration errors. Navigate to Orchestrator >
Audit Logs and enter Netskope in the search field above the table.
Service Orchestration
Configuration > Cloud Services > Service Orchestration
To watch a video of this feature, see How to Integrate with Third-Party Service Providers.
Use the Service Orchestration tab to automate the integration of third-party service providers
without an API. Service Orchestration automates the creation and deployment of IPSec tunnels
and IP SLA probes and manages the lifecycle of the tunnels and probes.
Service Orchestration creates a local tunnel identifier (IKE ID) for each tunnel to the third-party
service provider. After the tunnels are created, complete the integration on the third-party
service provider’s site by replacing the source identity values with the local tunnel identifiers
(IKE IDs) that Orchestrator created for each endpoint.
Prerequisites
• You must have loopback interfaces configured to use the Service Orchestration feature.
• Service Orchestration supports third-party service providers that use IPSec IKEv2 end-
points.
• You will need the following information from the third-party service provider for each
endpoint you want to add:
– Endpoint name
– IP address
– Probe address
– Probe type (Ping or HTTP/HTTPS)
Field Description
2. Click Save.
A new tab is created on the Service Orchestration page.
TIP: To edit or delete a service, click the edit icon next to the service name.
3. Select the tab for the new service and follow the steps below to integrate this new service.
Field Description
Edit this field for each endpoint. This value can be an ASCII string,
a hex-encoded string (if it has a 0x prefix), or a base64-encoded
string (if it has a 0s prefix).
Field Description
Probe Address The third-party service provider endpoint that the IP SLA
subsystem will ping. You can obtain the probe address from the
third-party service provider.
4. Click Save.
5. Repeat steps 2 - 4 for each endpoint you want to add.
6. After your endpoints are created, enter the probe address and a backup remote endpoint
for each endpoint you defined.
Field Description
Probe Address The third-party service provider endpoint that the IP SLA
subsystem will ping. You can obtain the probe address from the
third-party service provider.
TIP: To delete an endpoint, click the X in the last column in the table.
7. Click Save.
Updates are orchestrated immediately.
2. Click Import to import a list of remote endpoints from a CSV file. The CSV file must
contain columns for name, IP address, interface label, pre-shared key, probe address,
and backup remote endpoint, in that order.
NOTE: Remove any header rows before you import the file.
3. Click Choose File.
4. Navigate to the file, select the file, and then click Open.
5. Click Save.
Updates are orchestrated immediately.
Bulk Edits
To make bulk edits to the table:
1. Click Export.
2. Open the CSV file and delete the three header rows.
3. Modify, save, and close the file.
4. Click Import, and then click Choose File.
5. Locate and select the file, and then click Open.
Orchestrator updates the table.
6. Click Save.
Interface Labels
Select the Primary and Backup interface labels for your traffic. Backup interface labels will be
used if the primary interface labels are unreachable.
Tunnel Settings
1. Click Tunnel Settings to configure the tunnel settings.
The Tunnel Settings dialog box opens. The General tab is displayed with the Mode field
set to IPSec.
Field Description
Mode Indicates that the tunnel protocol is IPSec. You cannot edit this
field.
IPSec Suite B Preset Select an IPSec Suite B Preset if required by the security service
(GCM-128, GCM-256, GMAC-128, or GMAC-256). The default
setting is None.
3. Click the IKE tab, and then complete the following fields.
Field Description
If the IPSec Suite B Preset field is set to any other setting, this
field is automatically set to the appropriate group.
Rekey interval/lifetime Rekey interval/lifetime of IKE security association (SA) in
minutes. The default is 480 minutes.
Field Description
Dead peer detection Delay time: The interval (in seconds) to check the lifetime of
the IKE peer.
You can create custom IKE IDs by specifying one or more of the
following macros:
4. Click the IPSec tab, and then complete the following fields:
Field Description
Field Description
IPSec anti-replay Select a size from the drop-down list or Disable to disable the
window IPSec anti-replay window.
5. Click Save.
TIP: Click Use Default to reset all tunnel settings to the global defaults for Service Orchestra-
tion.
IP SLA Settings
1. Click IP SLA Settings.
The IP SLA Settings dialog box opens.
2. If all fields are dimmed, click Enable IP SLA rule orchestration.
3. Complete the following fields.
Field Description
4. Accept the default values for the remaining fields, and then click Save.
Orchestrator builds the tunnels.
BIO Breakout
By default, the tunnels associated with a third-party service provider will be available for BIOs.
You can upload an icon to display on the Business Intent Overlays tab.
NOTE: Supported file types include PNG, JPEG, SVG, and WEBP. The recommended dimensions
are 60 x 20 pixels.
If you do not want this third-party provider to be available for BIOs, do the following:
1. In the Orchestrator appliance tree, select one or more appliances to associate with the
third-party service provider remote endpoints.
2. Click Remote Endpoint Association.
The Associate an Appliance to Remote Endpoints dialog box opens.
3. Select the Add or Remove check box next to the endpoints you want to associate with
the selected appliances. Be sure to add the endpoints that are geographically closest to
the appliances.
4. Verify the proposed changes to remote endpoints in the table to the right, and then click
Save.
If you created a custom IKE ID, the local tunnel identifier value will follow the format
you defined in the IKE identifier field on the Tunnel Settings dialog box.
1. In the Orchestrator appliance tree, select all appliances associated with third-party ser-
vice provider remote endpoints.
2. On the third-party service provider page on the Service Orchestration tab, click Export
to save the contents of the table to a CSV file.
3. Log in to the third-party service provider.
4. In the IPSec/Location configuration panel, replace the Source Identity values with the
corresponding Tunnel Local Identifiers (IKE IDs) created by Orchestrator.
Verification
After the third-party service provider is configured and the third-party service provider policy
is applied successfully in the BIO, deployment will begin automatically. Go to the third-party
service provider tab and view the Connection Status column to verify that the deployment was
successful.
1. On the AWS dashboard, Azure portal, or GCP dashboard, create an Identity and Access
Management (IAM) user account with required permissions for Orchestrator to create
resources. A dedicated IAM user account for Orchestrator is recommended.
1. Create a policy that contains all permissions the Orchestrator requires to create an
EC-V.
2. Attach the policy to the Orchestrator’s IAM user account.
3. Download the Security credentials of the Orchestrator’s IAM user account.
2. If you are deploying EV-Cs in AWS, on the EC2 dashboard, create a key pair to assign to
the EC-V. You will need this key pair if you want to SSH into the EC-V after the deployment.
After creating the IAM account, click New Deployment on the Cloud Hubs in AWS, Cloud
Hubs in Azure, or Cloud Hubs in GCP tab to configure and deploy one or more EC-V cloud
instances.
After deploying an EC-V in the cloud, navigate to the Discovered Appliances page in Orchestra-
tor to view the deployment status. If the EC-V is still being deployed, the status in the Approve
column will indicate Configuring. It takes approximately ten minutes to deploy and configure
a cloud EC-V. Click Refresh Discovery Information to determine whether the appliance is
ready to be approved into the SD-WAN fabric.
When configuration is complete and the green Approve button appears, the EC-V is fully con-
figured in Inline Router mode with mgmt0, wan0, and lan0 MAC addresses assigned. While
adding the EC-V, the Deployment Profile page will show LAN IP address, WAN IP address, WAN
interface firewall mode, and WAN bandwidth value assigned by Orchestrator.
You can upgrade the appliance software version on a cloud EC-V after approving and adding
it to the SD-WAN fabric.
After a cloud EC-V has been deployed, you can add another EC-V into the same deployment.
The new EC-V will use the same settings from the existing deployment configuration such as
account, region, VPC, key pair, and instance type. You can deploy the new instance into an
Availability Zone that is already used by an existing appliance or a new Availability Zone.
NOTE: Before you can deploy EC-Vs to the AWS cloud, you must perform several tasks in AWS.
For more information, see AWS Account Configuration.
The following table describes each field on this tab.
Field Description
Field Description
Remove an EC-V
If a deployment does not complete or you no longer want the EC-V in the AWS cloud, you can
remove the deployment and all associated artifacts.
To remove a deployment, locate the deployment you want to remove, and then click Termi-
nate in the desired row.
AWS Accounts
The AWS Accounts dialog box lists all of the AWS accounts that have been added.
• Click Add AWS Account to create a new account for EC-V deployments.
• Click the edit icon next to an existing account to modify that account’s details.
1. Navigate to the EdgeConnect SD-WAN product page: AWS Marketplace: Silver Peak Unity
EdgeConnect for AWS
2. Click Continue to Subscribe. If prompted, log in to your AWS account.
3. Under Terms and Conditions, click Accept Terms. The subscription might take a few
minutes to process.
4. After the Thank you message appears, proceed with launching your instance.
Field Description
Name Enter a unique name. If you have multiple AWS accounts, you must enter a
unique name for each account.
Access Key Enter the Orchestrator IAM user’s Access Key ID that you saved earlier.
Secret Key Enter the Orchestrator IAM user’s Secret Key ID that you saved earlier.
Comment Enter a comment that provides any additional information about the AWS
account.
Field Description
Name Enter a name for the deployment. This name is used only for
identifying the deployment. A deployment consists of one or
more EC-Vs that an Orchestrator creates in an AWS Virtual
Private Cloud (VPC). Only alphanumerical letters and hyphens
are allowed in the deployment name. The maximum allowed
length is 20 characters.
AWS Account Select an AWS account to use for deploying the EC-V.
Region Select an AWS region where you want to deploy the EC-V.
VPC CIDR Enter a VPC Classless Inter-Domain Routing (CIDR) block. The
smallest supported CIDR block is /24 and the largest supported
CIDR block is /16. Orchestrator creates all AWS resources
required for the EC-V deployment within this VPC. For each
EC-V you deploy, Orchestrator creates three subnets that are
/28 in size. In other words, if you deploy two EC-Vs,
Orchestrator creates six subnets in total. This is true even if
both EC-Vs are created in a single Availability Zone.
SSH Key Select an existing AWS key pair to assign to the EC-V. A key pair
must be created prior to the deployment.
WAN Optimization WAN Optimization requires additional resources on an AWS
(Optional) EC2 instance. After WAN Optimization and an appropriate WAN
Bandwidth value are selected, Orchestrator displays the
appropriate AWS instance types for the deployment on the
Instance Type drop-down menu.
Field Description
AWS Tags (Optional) Any comma-separated tags entered here are applied to all AWS
resources that Orchestrator creates while deploying the EC-V. If
you do not enter any tags, Orchestrator automatically creates a
unique tag for each AWS resource that it creates while
deploying the EC-V. This AWS tag is created to identify each
resource created by Orchestrator. The tag is formatted as
follows: sp-automated-deployment
name-instance-index-resource name.
Comment (Optional) Enter an optional comment if you want to attach any additional
details for the deployment.
Advanced Settings Custom AMI ID: If you want to deploy the EC-V with a specific
public or private image, provide the AMI ID. You can obtain the
AMI ID from the AWS console.
When you have completed all of the required fields, click Review and Deploy. Review the
configuration summary, and click Deploy to create the EC-V instances.
Field Description
If the region you selected does not support Availability Zones, the new
Instance in Azure dialog box will not display an Availability Zone menu.
Region Region of the EC-V deployment.
Resource Group Name of the Azure Resource Group that was used for the EC-V
deployment.
Status Status of the deployment. If more information is available, an
information icon is displayed.
If you created more than one EC-V in the deployment, all EC-Vs will be
deleted when you click Terminate. The Resource Group that was used
for the deployment will not be deleted.
Deployment Info Click the info icon in this column to view deployment and virtual
machine details.
Resources Click the info icon in this column to view details about each Azure
resource that Orchestrator created during the deployment.
Comment Comments that were added to the deployment when the EC-V was
created. To edit the comment, click the edit icon.
Remove an EC-V
If a deployment does not complete or you no longer want the EC-V in the Azure cloud, you can
remove the deployment and all associated artifacts.
To remove a deployment, locate the deployment you want to remove, and then click Termi-
nate in the desired row.
Azure Subscriptions
The Azure Subscriptions dialog box lists all the Azure subscriptions that have been added to
Orchestrator.
1. Click the edit icon next to an existing subscription to modify that subscription’s details.
The Azure Subscription Configuration dialog box displays.
NOTE: You cannot modify subscriptions that have active deployments.
2. Modify the elements as necessary.
3. Click Save.
Orchestrator validates the subscription information.
4. Click Close.
1. Accept Azure Marketplace image terms for EdgeConnect to enable programmatic de-
ployment
2. Create a New App Registration (also known as a Service Principle)
3. Create a New Resource Group
4. Create a Custom Role
5. Assign the Custom Role to the Resource Group
You will need the following information as noted in the steps below to add the Azure subscrip-
tion to Orchestrator:
• Subscription ID
• Tenant ID
• Client ID
• Client Secret
4. On the Plan drop-down menu, select Silver Peak Unity EdgeConnect 8.3.0.19, and then
click Get started.
5. On the Configure Programmatic Deployment page, select Enable next to the subscription
ID that you want to use to deploy the EdgeConnect VMs.
6. Click Save.
A message at the top of the screen notifies you when configuration updates are com-
plete.
1. On the main search menu, enter resource group, and then select the Resource groups
menu.
2. Click + Create.
3. On the Create a resource group page, select the subscription that you want to use to
create the resource group.
4. Enter a name for the resource group, and then select a region.
5. Click Review + create.
6. Click Create.
Continue to Create a Custom Role.
1. Select the resource group you created in Create a New Resource Group, and then click
Access control (IAM).
2. Click Add, and then click Add custom role.
The Custom Roles editor opens (the Basic tab is displayed).
3. In the Custom role name field, enter a name for the custom role. The name must be
unique for the Azure AD directory. The name can include letters, numbers, spaces, and
special characters.
4. In the Description field, enter an optional description for the custom role. The descrip-
tion will display in the tool tip for the custom role.
5. Accept the default value for the Baseline permissions, and then click the JSON tab.
6. Click Edit.
7. Go to this web page and click Permissions required to deploy Cloud Hubs in Azure.
8. Copy the list of Azure permissions, and then paste the list within the square brackets
under Actions (line 10), as shown in the following figures.
9. Click Save.
10. Click the Assignable scopes tab. Verify that the resource group you created is added as
an assignable scope and Type is set to the resource group.
11. Click the Permissions tab. Verify that the permissions, descriptions, and permission
types you added are listed.
12. Click Review + create.
13. Click Create. A message displays to confirm that you have successfully created your
custom role. Continue to Assign the Custom Role to the Resource Group.
1. Log in to Orchestrator.
2. Click Configuration > IaaS > Deploy Cloud Hubs in Azure.
3. Click Azure Subscriptions.
4. Click Add Azure Subscription.
5. Enter the Subscription ID, Tenant ID, Client ID, and Client Secret for the Azure subscrip-
tion.
NOTE: If you copy and paste the subscription ID, Azure might add a blank space to the
beginning of the subscription ID. Be sure to remove all spaces from your subscription ID.
6. Click Save.
Orchestrator validates the subscription information.
Field Description
Name Enter a name for the deployment. This name is used only for
identifying the deployment. A deployment consists of one or
more EC-Vs that an Orchestrator creates in an Azure Virtual
Network. Only alphabetical letters and hyphens are allowed in
the deployment name. The maximum allowed length is 20
characters.
Azure Account Select an Azure account to use for deploying the EC-V.
Resource group Select an Azure resource group to use for deploying the EC-V.
Region Select an Azure region where you want to deploy the EC-V.
Field Description
Field Description
Use this:
NOTE: Save the private key file. If you need to log in via SSH to
the appliance after it is deployed, you will need this key.
Field Description
Azure tags (Optional) Any comma-separated tags entered here are applied to all
Azure resources that Orchestrator creates while deploying the
EC-V. If you do not enter any tags, Orchestrator automatically
creates a unique tag for each Azure resource that it creates
while deploying the EC-V. This Azure tag is created to identify
each resource created by Orchestrator. The tag is formatted as
follows:
sp-automated-deployment name-instance-index-resource name.
Comment (Optional) Enter an optional comment if you want to attach any additional
details for the deployment.
Advanced settings Custom VHD: Leave this field blank unless you have an
EdgeConnect VHD that you want to use for the deployment.
When this field is blank, the Azure Marketplace image is
deployed.
Horizontally scale You can deploy multiple EC-Vs by clicking + and selecting the
Availability Set or Availability Zone for each EC-V. If the selected
region supports multiple Availability Zones, each Availability
Zone displays on the menu. You can deploy up to 5 EC-Vs with a
CIDR block of /24.
If you need to deploy more than five EC-Vs within a single virtual
network, select a virtual network CIDR block that is bigger than
/24, such as /23 or /22. The maximum number of EC-Vs you can
deploy within a single network is 20.
Appliance tag (Optional) Enter an Appliance Tag. If this field is left blank, Orchestrator
automatically assigns an Appliance Tag for its own configuration
purposes.
Availability zone Enter the Azure Availability Zone for the EC-V.
3. When you have completed all the required fields, click Review and Deploy.
4. Review the configuration summary, and then click Deploy to create the EC-V instances.
Field Description
NOTE: If the deployment failed for the selected instance, the info dialog
contains a link to download the log file and steps to resolve the issue.
Terminate To terminate an EC-V instance in GCP, click Terminate. This action
deletes all resources associated with the selected EC-V instance.
Deployment Info Click the info icon in this column to view details of the selected EC-V
instance, including the IP addresses associated with the mgmt0, wan0,
and lan0 interfaces.
Resources Click the info icon in this column to view details about all GCP
resources that Orchestrator created during the deployment for the
selected EC-V instance.
Info The appliance hostname after it has been approved and added to
Orchestrator. If an appliance has not been approved, this column will
be blank.
Comment Comments that were added to the deployment when the EC-V was
created. To edit the comment, click the edit icon.
Manage an EC-V
If a deployment does not complete or you no longer want the EC-V in the GCP cloud, you can
remove the deployment and all associated artifacts.
To remove a deployment, locate the deployment you want to remove, and then click Termi-
nate in that row.
GCP Accounts
The GCP Service Accounts dialog box lists all of the GCP accounts that have been added.
• To create a new account for EC-V deployments, click New GCP Account.
• To modify an existing account’s details, click the edit icon next to the account.
3. Exit Cloud Shell and verify that Custom Role for SD-WAN Orchestrator is enabled in
the list of roles for your project.
• compute.disks.create
• compute.firewalls.create
• compute.firewalls.delete
• compute.firewalls.get
• compute.images.get
• compute.instances.create
• compute.instances.delete
• compute.instances.get
• compute.instances.setMetadata
• compute.networks.create
• compute.networks.delete
• compute.networks.get
• compute.networks.updatePolicy
• compute.regions.list
• compute.subnetworks.create
• compute.subnetworks.delete
• compute.subnetworks.get
• compute.subnetworks.use
• compute.subnetworks.useExternalIp
• compute.zones.get
NOTE: These permissions cannot be batch-added in GCP. For each entry, you must
search for the permission, select the check box next to it, and then click Add.
7. On the Create Role page, verify the assigned permissions, and then click Create.
Field Description
NOTE: You only need to enter this value once per GCP project.
Region Select the GCP region where you want to deploy the EC-V.
Field Description
When you have completed all of the required fields, click Review and Deploy. Review the
configuration summary, and then click Deploy to create the EC-V instances.
Administration
The menus under Administration are related to appliance administration. They include gen-
eral settings, software management, and tools for troubleshooting and maintenance, and are
organized as follows:
• General Settings
• Software
• Tools
Appliance Users
Administration > General Settings > Users & Authentication > Appliance Users
This tab provides data about the user accounts on each appliance.
The EdgeConnect appliance’s built-in user database supports user names, groups, and pass-
words.
• Each appliance has two default user accounts, admin and monitor, that cannot be deleted.
• Each user name belongs to one of two user groups: admin or monitor.
– The monitor group supports reading and monitoring of all data, in addition to per-
forming all actions. This is equivalent to the Command Line Interface’s (CLI) enable
mode privileges.
– The admin group supports full privileges, along with permission to add, modify, and
delete. This is equivalent to the CLI’s configuration mode privileges.
• Named user accounts can be added by using the Appliance Manager or the Command
Line Interface (CLI).
• User names are case-sensitive.
• The table lists all users known to the appliances, whether or not their accounts are en-
abled.
• Each appliance has two default user accounts, admin and monitor, that cannot be deleted.
• Each user name belongs to one of two user groups: admin or monitor.
– The monitor group supports reading and monitoring of all data, in addition to per-
forming all actions. This is equivalent to the Command Line Interface’s (CLI) enable
mode privileges.
– The admin group supports full privileges, along with permission to add, modify, and
delete. This is equivalent to the CLI’s configuration mode privileges.
• Named user accounts can be added by using the Appliance Manager or the Command
Line Interface (CLI).
• User names are case-sensitive.
• The table lists all users known to the appliances, whether or not their accounts are en-
abled.
Auth/RADIUS/TACACS+ Tab
Administration > General Settings > Users & Authentication > Auth/RADIUS/TACACS+
This tab displays the configured settings for authentication and authorization.
If the appliance relies on either a RADIUS or TACACS+ server for those services, those settings
are also reported.
All settings are initially applied via the Auth/RADIUS/TACACS+ configuration template.
Field Description
Field Description
Authentication Order
Choose which authentication database you want to be First, Second, and Third from the des-
ignated drop-down lists.
Authorization Information
Select the Map Order and the Default Role from the designated drop-down lists.
This tab displays the configured settings for authentication and authorization.
If the appliance relies on either a RADIUS or TACACS+ server for those services, those settings
are also reported.
All settings are initially applied via the Auth/RADIUS/TACACS+ configuration template.
Field Description
Authentication Process of validating that the end user, or a device, is who they
claim to be.
Authorization Action of determining what a user is allowed to do. Generally,
authentication precedes authorization.
Authentication Order When it is possible to validate against more than one database
(local, RADIUS server, TACACS+ server), Authentication Order
specifies which method to try in what sequence. Default is
Local-first.
Map Order Default (and recommended) value is Remote First.
Default Role Default (and recommended) value is admin.
Field Description
Field Description
Timeout If a logged-in user is inactive for an interval that exceeds the inactivity
time-out, the appliance logs them out and returns them to the login page.
You can change that value, as well as the maximum number of sessions, in
the Session Management template.
As an example of where to find this file, on a FreeRADIUS server, the path is here: /etc/
raddb/clients.conf
6. Verify that this configuration is in effect by using TCP dump in Orchestrator or via the CLI
on your EdgeConnect. You should see that the CHAP message authenticator is included
in packets that are exchanged with the RADIUS server.
NOTE: If this configuration is not in effect, the RADIUS server will still work and a security
vulnerability will exist.
Date/Time Tab
Administration > General Settings > Setup > Date/Time
The Date/Time tab indicates the time zone and Network Time Protocol (NTP) settings for one or
more appliances selected in the appliance tree. It can also indicate time discrepancies between
your devices (appliances, the Orchestrator Server, and your browser). If the dates and times
of devices are not synchronized, charts and report statistics will have varying timestamps for
the same data.
Time differences shown for Orchestrator and your browser (client machine) are relative to the
respective appliances. Appliance times should be within a minute of Orchestrator and browser
times. If exceeded, an appliance alarm is issued.
TIP: To synchronize times, it is recommended that you configure the appliance, the Orches-
trator server, and your client machine to use an NTP (Network Time Protocol) server.
To configure a synchronized date and time for an appliance, click the edit icon in the row
associated with the appliance. The Date/Time Settings dialog box opens.
1. Select the appropriate time zone for your network from the Time zone drop-down list.
2. Select one of the following time/date configuration options:
3. Click Save.
A Domain Name Server (DNS) uses a table to map domain names to IP addresses so you
can reference locations by a domain name, such as mycompany.com, instead of using the IP
address.
Each appliance can support up to three name servers.
Field Description
To add the three domain name servers, click the Edit icon.
SNMP Tab
Administration > General Settings > Setup > SNMP
This tab summarizes the SNMP configuration for each of the selected appliances.
SNMP Overview
EdgeConnect appliances support Management Information Base (MIB-II) as described in RFC
1213 for cold start traps, warm start traps, and EdgeConnect private MIBs. Appliances issue an
SNMP trap during reset when loading a new image, recovering from a crash, or rebooting.
An appliance sends a trap every time an alarm is raised or cleared. Traps contain additional
information about alarms, including severity, sequence number, a text-based description of
the alarm, and the time the alarm was created. For more information, you can download a
.zip archive containing supported MIBs here.
1. To activate configuration options for SNMP v1/v2, SNMP v3, and Trap Receivers details,
select the Enable SNMP check box.
2. If you select the Enable SNMP Traps check box, the SNMP agent on the appliance sends
traps to configured receivers.
3. Use the Default Trap Community field to specify the string the trap receiver uses to
accept traps being sent to it. The default value is public. You can modify this value.
SNMP v1/v2
Field Description
Enable SNMP Allows the SNMP agent on the appliance to send traps to
configured receivers.
Read-Only The SNMP application needs to present this text string (secret) to
Community poll the appliance’s SNMP agent. The default value is public. You
can modify this value.
SNMP v3
For additional security, configure SNMP v3 if you want to authenticate without using clear
text. To add an SNMP v3 user, click Add above the SNMP v3 table and configure the following
properties:
Field Description
Enabled Select this check box to enable the selected user. Clear this
check box to disable the user and maintain the configuration.
Username Enter the username to identify the SNMP v3 user.
Field Description
Authentication Type Select the authentication type to use for SNMP requests from
the user.
To delete an SNMP v3 user, click the X to the right of the entry in the table.
Trap Receivers
To configure a trap receiver, click Add above the Trap Receivers table and configure the fol-
lowing properties:
NOTE: You can configure up to three trap receivers per appliance.
Field Description
For v3, specify the SNMP v3 user that is sending traps to the
receiver.
Enabled Select this check box to enable the receiver. Clear this check box
to disable the receiver and maintain the configuration.
To delete a receiver, click the X to the right of the entry in the table.
1. Select the Enable SNMP check box to activate configuration options for SNMP v1/v2,
SNMP v3, and Trap Receivers details.
2. If you select the Enable SNMP Traps check box, the SNMP agent on the appliance sends
traps to configured receivers.
3. Use the Default Trap Community field to specify the string the trap receiver uses to
accept traps being sent to it. The default value is public. You can modify this value.
SNMP v1/v2
Configure the following fields for SNMP v1 and v2c.
Field Description
Enable SNMP Allows the SNMP agent on the appliance to send traps to
configured receivers.
Read-Only The SNMP application needs to present this text string (secret) to
Community poll the appliance’s SNMP agent. The default value is public. You
can modify this value.
SNMP v3
For additional security, configure SNMP v3 if you want to authenticate without using clear
text. To add an SNMP v3 user, click Add above the SNMP v3 table and configure the following
properties:
Field Description
Enabled Select this check box to enable the selected user. Clear this
check box to disable the user and maintain the configuration.
Username Enter the username to identify the SNMP v3 user.
Authentication Type Select the authentication type to use for SNMP requests from
the user.
Field Description
Privacy Type Select the encryption type to use for encrypting requests from
the SNMP user.
To delete an SNMP v3 user, click the X to the right of the entry in the table.
Trap Receivers
To configure a trap receiver, click Add above the Trap Receivers table and configure the fol-
lowing properties:
NOTE: You can configure up to three trap receivers per appliance.
Field Description
For v3, specify the SNMP v3 user that is sending traps to the
receiver.
Enabled Select this check box to enable the receiver. Clear this check box
to disable the receiver and maintain the configuration.
To delete a receiver, click the X to the right of the entry in the table.
To open the Flow Export Configuration dialog box, click the Edit icon.
clientIPv4Address default 4 1
connectionNumberOfConnections totalCounter 1 9
Currently 1.
connectionTransactionCompleteCount totalCounter 1 21
Currently 1.
Field
Custom IE Name and Implementation Length Enterprise
Description Semantics Units (bytes) ID
connectionServerResponseDelay microseconds 4 11
Currently 1.
connectionClientToServerNetworkDelay microseconds 4 15
Field
Custom IE Name and Implementation Length Enterprise
Description Semantics Units (bytes) ID
connectionApplicationDelay microseconds 4 16
Field Description
Enable Flow Exporting Move the toggle to enable or disable flow exporting.
Active Flow Timeout Amount of time an active flow has been timed out (in minutes).
IPFIX Template Timeout Resending of templates based on a timeout.
Traffic Type Check as many of the traffic types as you want. The default is
WAN TX.
Information Elements Check Firewall Zones, Application Performance, or both.
• For more information about IPFIX and the associated Custom Information Elements (IEs),
see Cloud Information Elements.
Logging Tab
Administration > General Settings > Setup > Logging
The Logging tab summarizes the following configured logging parameters:
• Log Settings refers to local logging.
• Log Facilities Configuration refers to remote logging.
The logs keep track of alarms, events, and any other issues involving your appliances.
The following table provides more details.
Field Description
To edit the logging configuration for one of the listed appliances, click the edit icon in the left
column of the table. The Logging dialog box opens. For details, see Logging Dialog Box
Severity Levels
In order of decreasing severity, the levels are as follows:
These are related to event logging levels, not alarm severities, even though some naming con-
ventions overlap. Events and alarms have different sources. Alarms, when they clear, list as
the ALERT level in the Event Log.
Remote Logging
• You can configure the appliance to forward all events, at and above a specified severity,
to a remote syslog server.
• A syslog server is independently configured for the minimum severity level that it will
accept. Without reconfiguring, it might not accept as low a severity level as you are for-
warding to it.
• Each message/event type (System / Audit / Firewall / Ids) is assigned to a syslog facility
level (local0 to local7).
Log Settings
Setting Description
Minimum severity level Minimum severity level that the system will log. (See the
WARNING note above.) For details about severity levels,
see Severity Levels.
Start new file when log Enter the maximum size (in MB) for a log file. Orchestrator
reaches generates a new file when this maximum size is reached.
Specify a size from 1 to 50.
Keep at most log files Maximum number of log files to allow to be stored.
Specify a value from 1 to 100.
Log stateful wan-interface Select to log information for discarded inbound packets,
drops even at high-traffic rates.
NOTE: When you click the Anonymize IPs check box, the
Jsonify check box is automatically selected.
2. Click the edit icon next to the appliance for which you want to configure a receiver.
The Logging dialog box opens.
3. Under Remote Log Receivers, click Add and then configure the following information.
Field Description
Banners Tab
Administration > General Settings > Setup > Banners
This tab lists the banner messages on each appliance.
• Use an EST server and globally orchestrated end entity profiles to automate cer-
tificate enrollment. This is the recommended option. For more information about this
method, see End Entity Certificates.
NOTE: Configuration for this method is not done on this tab.
• Manually create a Certificate Signing Request (CSR) in Orchestrator. As part of this
process, Orchestrator creates the public key private key pair. The user downloads and
submits the CSR for signing by a Certificate Authority (CA). The signed certificate is then
uploaded in Orchestrator for use in one of several applications. The end entity certificate
contains a label, which is significant to Orchestrator and allows this certificate to be used
by referring to its label. You must repeat this process for each EdgeConnect appliance.
To use an end entity certificate obtained by manually creating a CSR in Orchestrator:
NOTE: To use an end entity certificate, you must first create an end entity certificate for
use. To do this, see End Entity Certificates Tab.
NOTE: This must be performed one appliance at a time.
1. Navigate to Administration > General Settings > Setup > HTTPS Certificate.
2. Click the edit icon next to the appliance for which you want to add a certificate.
3. Click End Entity Certificate and then select the end entity certificate from the drop-
down menu.
4. Click Save.
• Use a Custom Certificate. This requires everything to be done externally including cre-
ating the public key private key pair and creating the CSR. This legacy method is not
recommended.
To use a Custom Certificate (legacy method):
1. Consult with your IT security team to generate a certificate signing request (CSR),
and then submit it to your organization’s chosen SSL Certificate Authority (CA).
– Examples of Certificate Authorities include GoDaddy, Verisign, Comodo, Syman-
tec, Microsoft Entrust, GeoTrust, and so forth.
– All certificate and key files must be in PEM format.
2. After the Certificate Authority provides a CA-verified certificate, navigate to Admin-
istration > General Settings > Setup > HTTPS Certificate.
3. Click the edit icon next to the appliance for which you want to add a certificate.
4. Click Custom Certificate, and then click Upload and Replace.
The Add HTTPS Certificate dialog box appears.
5. If your IT security team advises the use of an Intermediate CA, upload an Interme-
diate Certificate File. Otherwise, skip this file.
6. Upload the Certificate File from the CA.
7. Upload the Private Key File that was generated as part of the CSR.
8. Click Add to close the Add HTTPS Certificate dialog box.
9. Click Save.
1. Click the edit icon for one of the tag rows associated with the appliance.
The Custom Appliance Tags dialog box opens. The table lists eight tag rows you can use
for the appliance.
2. For each tag you want to create for the appliance, type the name for the key in the Key
field, and then type the value you want to assign to the key in the Value field.
3. When you finish specifying tags for the appliance, click Save.
System Information
Administration > Software > Upgrade > System Information
You can manage system information with templates (except for Deployment Mode, which is an
appliance-specific configuration). To change a Deployment Mode, navigate to Configuration
> Networking > Deployment.
When you click the edit icon next to a specific appliance, the following two screens are avail-
able.
System Summary
Appliance Key Orchestrator assigns and uses this key to identify the
appliance.
Platform Underlying cloud platform on which the EdgeConnect
appliance runs, such as Amazon EC2, Azure, Google Cloud,
or VMware.
Uptime Time elapsed since the appliance became operational and
available.
Active Release Specifies the software release the appliance is running.
Appliance ID Unique identifier for the appliance.
Discovery Method Specifies how Orchestrator discovered the appliance:
System Settings
disable: When the original tunnel fails, the flows are not
routed to another tunnel.
Encrypt data on disk Enables encryption of all the cached data on the disks.
Disabling this option is not recommended.
Configured media type Is either ram and disk (VX) or ram only (VRX). Can be
changed for special circumstances if recommended by
Support.
Media type Displays the actual media being used.
Shell access status Specifies the current shell access policy for EdgeConnect
appliances.
IPSec UDP port Specifies the port that Orchestrator uses to build IPSec
UDP tunnels. If the field is blank, Orchestrator uses the
default.
Enable default DNS lookup Allows the appliance to snoop the DNS requests to map
domains to IP addresses. This mapping then can be used
in ACLs for traffic matching.
Enable HTTP/HTTPS snooping Enables a more granular application classification of
HTTP/HTTPS traffic by inspection of the HTTP/HTTPS
header, Host. This is enabled by default.
Quiescent tunnel keep alive Specifies the rate at which to send keep alive packets after
time a tunnel has become idle (quiescent mode). The default is
60 seconds.
UDP flow timeout Specifies how long to keep the UDP session open after
traffic stops flowing. The default is 120 seconds (2
minutes).
Non-accelerated TCP flow Specifies how long to keep the TCP session open after
timeout traffic stops flowing. The default is 1800 seconds (30
minutes).
Maximum TCP MSS Maximum Segment Size. The default value is 1328 bytes.
This ensures that packets are not dropped for being too
large. You can adjust the value (500 to 9000) to lower a
packet’s MSS, if your environment requires a lower size.
NAT-T keep alive time If a device is behind a NAT, this specifies the rate at which
to send keep alive packets between hosts to keep the
mappings in the NAT device intact.
Tunnel alarm aggregation Specifies the number of alarms to allow before alerting
threshold the tunnel alarm.
Maintain end-to-end overlay Enforces the same overlay to be used end-to-end when
mapping traffic is forwarded on multiple nodes.
IP directed broadcast Allows an entire network to receive data that only the
target subnet initially receives.
Allow WAN to WAN routing Redirects inbound WAN traffic back to the WAN.
Allow Unknown Destination Indicates whether to allow unknown destination roles.
Role
Stateful-SNAT exceptions Name of the address group configured for Stateful-SNAT
exceptions (for example, Stateful-SNAT-Exceptions). To set
up this address group, see Disable Stateful+SNAT
Processing for Selected LAN-side Subnets below.
• Stateful-SNAT exceptions apply only to appliances with firewall mode set to “State-
ful+SNAT”.
• Exceptions apply only to outbound flows destined to external addresses.
• Inbound flows initiated from the WAN side toward IP addresses within the address group
rely on existing inbound port-forwarding functionality.
• SNAT exceptions apply to the default segment only, not VRF SNAT.
• This feature does not support IPv6 because the address groups feature does not support
IPv6.
You can use the System template to set up Stateful-SNAT exceptions for all appliances or the
System Information dialog box for individual appliances. To set up exceptions for all appli-
ances, see System Template.
To set up Stateful-SNAT exceptions for individual appliances:
1. Create an address group for all public IP space (subnets) used by your network across all
branches, as follows:
1. Navigate to Configuration > Templates & Policies > ACLs > Address Groups.
The Address Groups tab opens.
2. Click Add Group.
The Add Address Group dialog box opens.
3. In the Group name field, enter an appropriate name for the Stateful-SNAT excep-
tions (for example, Stateful-SNAT-Exceptions).
4. In the IPs to include and IPs to exclude fields, enter IP addresses/masks to in-
clude/exclude individually or IP prefixes to include/exclude multiple addresses at
once, as appropriate. Use commas to separate entries.
5. If desired, use the Comment field to state the purpose of this address group.
6. Click Add.
2. In the Stateful-SNAT Exceptions field on the System Settings page of the System Infor-
mation dialog box, enter the name of the address group you created for Stateful-SNAT
exceptions, and then click Save.
Software Versions
Administration > Software > Upgrade > Software Versions
This tab lists the software versions on each appliance.
1. Select one or more appliances in the appliance tree, and then navigate to Administra-
tion > Software > Upgrade > Upgrade Appliances.
The Upgrade Appliances dialog box opens. The Target Appliances table lists the appli-
ances you selected.
• To upload an image file you downloaded to your machine, click Upload ECOS Image.
File Explorer opens. Navigate to the image file, and then click Open. When the
upload finishes, the image file appears in the Select ECOS Image table.
• To provide a URL for the image file, click Provide URL. Enter the URL for the image
file in the URL for image file field. When you click Provide URL, the Check Compat-
ibility button becomes available.
• If you uploaded an ECOS image file, select the new image file in the Select ECOS
Image table. The Compatible column in the Target Appliances table indicates com-
patibility for each appliance.
• If you provided a URL, click Check Compatibility to ensure that the image file is
compatible with your current appliance software. The Compatible column in the
Target Appliances table indicates compatibility for each appliance.
NOTE: If the image file is not compatible, do not proceed with the upgrade. Find and
select an image file that is compatible with the current versions of the appliances. Refer
to the Orchestrator Release Notes for more information.
4. Select one of the following install options:
• Install and reboot—Installs the image file into the appliance’s inactive partition and
reboots the appliance to use the new software.
• Install and set next boot partition—Installs the image file into the appliance’s in-
active partition and points to that partition for the next reboot.
• Install only—Downloads the image file into the inactive partition. Use this option to
store new appliance software from your network or computer to the Orchestrator
server.
5. Click Upgrade.
The upgrade process downloads the image file and then installs it onto the appliances.
Monitor the progress of the installation in the Target Appliances table. The Status column
will display “Upload in progress,” “Installing boot disk image file,” “Waiting for reboot to
finish,” and then “Success.”
6. Click Close.
7. If the upgrade was successful, monitor the appliance tree to verify that each appliance
reboots. This might take some time.
CAUTION: Be careful to consider any potential conflicts when the backup specifies a static
mgmt0 IP address, as opposed to specifying DHCP.
If you restore from a backup that is older than the latest backup, you could experience the
following:
• A loss of configuration changes that were made during the period between the older
backup and the latest backup.
• A loss of appliances that were added during the period between the older backup and
the latest backup.
• IPSec UDP tunnels may experience a brief outage as the new seed is applied.
This action deletes the appliance from the navigation tree. In addition, Orchestrator will break
all tunnels, overlays, and so forth to this device.
This action deletes the appliance from the navigation tree. In addition, Orchestrator breaks all
tunnels, overlays, and so forth to this device and tells the Portal to “unlicense” the appliance.
If your overall network experiences problems, you can use this dialog box to manually resync
and ensure that Orchestrator has an appliance’s current running configuration.
• In an in-line deployment (Bridge mode), the LAN interface is physically connected to the
WAN interface.
• In Server mode and any Router mode, the appliance is in an open-port state.
When the appliance is in Bypass mode, a message displays in red text in the upper-right corner
of the user interface.
For more information, see the EdgeConnect Command Line Interface (CLI) Reference.
• These tests run on the two selected appliances using user-specified parameters for band-
width, duration, DSCP marking, and type of traffic (tunnelized / pass-through-shaped /
pass-through-unshaped).
• Orchestrator runs the selected test twice—once passing traffic from Appliance A to Ap-
pliance B, and a second run passing traffic from Appliance B to Appliance A.
• Custom Parameters are available for tcpperf and should be used cautiously by advanced
users.
Option Description
-h help
-s server: Run tcpperf in server mode (not applicable for file generation). Listens on
TCP port 2153 by default. [server_port [server_port [server_port]..]]
-sr server range: <server_port_start:server_port_end>
Option Description
-c client server_IP: TCPperf Server’s IP address (not applicable for file generation).
[server_port [server_port [server_port]..]]
-cr <server_port_start:server_port_end> <server_port_start:server_port_end>
-g generate basefilename: Dump generated data to a file.
-sw sgwrite conffilename
NOTES:
General Parameters
Option Description
-6 ip6: Forces tcpperf to use IPv6 addresses only. Default is IPv4 addresses.
-I interface IP: Specify source interface IP address. Default is any.
-o outname: Output filename. Default is stdout.
-u update <secs>: Frequency of printed updates in seconds. Default is 1.
-d duration <secs>: Set maximum test duration in seconds. Default is infinite.
-w wait <secs>: Wait until <secs> since 1970 before transmitting data.
-z realtime: Elevate to realtime priority. Requires root privilege.
-cm cpu mask: Specify CPU affinity. Requires root privilege.
-q quiet <level>: Suppresses detail based on level:
TCP Parameters
Option Description
Option Description
Begin and end bytes can be greater than file size. The content is
repeated to create extra bytes.
Option Description
mutate: Ensures all flows and data repeats are unique. Preserves
short range patterns within flow. Destroys cross flow similarity.
Destroys original byte code distribution.
shuffle: Ensures all flows and data repeats are unique. Preserves
short range patterns within flow. Preserves cross flow similarity.
Preserves original byte code distribution.
fast: Ensures all flows and data repeats are unique. Does not
preserve short range patterns. Destroys cross flow similarity.
Destroys original byte code distribution. Uses less CPU than
mutate or shuffle.
-l loopback [mode]: Loopback. Default is unidirectional.
Option Description
global: Single global hash per flow. Fast, but cannot isolate an
errored block.
Option Description
-y defred <s% > <m%> <l%> <sb> <smin> <smax> <mb> <mmin>
<mmax> <lb> <lmin lmax>: Generate content based on defined
reduction model.
Option Description
Disk Management
Administration > Tools > Disk Management
The Disk Management tab lists information about physical and virtual appliance disks.
1. Log in to your Support portal account, and then click Open a Self Service RMA for disk
replacement.
2. Complete the wizard. Use the serial number of the appliance (not the disk).
3. After you receive the new disk, access Appliance Manager by clicking any edit icon that
belongs to the appliance in question.
4. Follow the instructions on that page’s online help.
• Reboot: Reboots the appliance gracefully. This is your typical “vanilla” restart.
Use case: You are changing the deployment mode or other configuration parameters that
require a reboot.
• Erase Network Memory and Reboot: Erases the Network Memory cache and reboots
the appliance.
Use case: You need to restart the appliance with an empty Network Memory cache.
• Shutdown: Shuts down the appliance and turns the power off. To restart, go to the
appliance and physically turn the power on with the Power switch.
Use cases:
Unless a virtual appliance is configured for a high availability deployment, all flows are discon-
tinued during reboot.
• Reboot: Reboots the appliance gracefully. This is your typical “vanilla” restart.
Use case: You are changing the deployment mode or other configuration parameters that
require a reboot.
• Erase Network Memory and Reboot: Erases the Network Memory cache and reboots
the appliance.
Use case: You need to restart the appliance with an empty Network Memory cache.
• Shutdown: Shuts down the appliance and turns the power off. To restart, go to the
appliance and physically turn the power on with the Power switch.
Use cases:
Unless a virtual appliance is configured for a high availability deployment, all flows are discon-
tinued during reboot.
TIP: To specify the time zone for scheduled jobs and reports, navigate to Orchestrator > Soft-
ware & Setup > Setup > Timezone for Scheduled Jobs.
Reachability Tab
Administration > Tools > Monitoring > Reachability Status
This tab displays status details about communications with EdgeConnect appliances. It in-
cludes the following two subtabs:
• Cloud Portal – Click to view current configuration and registration information for the
Cloud Portal connection. You can also view HTTPS and WebSocket reachability statuses.
• Orchestrator Reachability – Click to view how your appliances are connecting to Or-
chestrator, including the default Orchestrator IP address or domain name, whether the
Orchestrator management IP is being used, and any labels used to connect to Orches-
trator.
• Software Versions – Click to view active and inactive software versions for all appliances
in your network or those selected in the appliance tree.
Appliances/Orchestrator
This subtab displays status details on communications between your appliances and Orches-
trator, which helps in early detection of network or communication failures that might occur
over direct or Portal WebSockets.
Orchestrator provides automatic WebSocket failover from direct WebSocket to HPE Aruba Net-
working Cloud Portal WebSocket if communications over the direct WebSocket fail or become
stale. You can control how quickly failover occurs by selecting one of three failover modes:
Aggressive, Normal (default), or Slow. For details, see Select Fast WebSocket Failover Mode
below.
The listed appliances reflect all appliances in your network or those selected in the appliance
tree.
The Ping Interval (Sec) and Max Idle Time (Sec) columns reflect the current WebSocket failover
mode configuration. The other columns show live data. Click the refresh button to update this
data. You can also click Export to export the data to a CSV file.
The following table describes the fields on the Appliances/Orchestrator tab.
Field Description
Field Description
Field Description
Max Idle Time (Sec) Maximum idle time in seconds. Orchestrator closes the
direct WebSocket with the appliance if a message is not
received from the appliance within the Max Idle Time. This
value reflects the current WebSocket failover mode
selection. To change the mode, see Select Fast WebSocket
Failover Mode below.
You can use the Fast WebSocket Failover Mode dialog box to select a mode for WebSocket
failover to the Portal WebSocket when the direct WebSocket fails or becomes stale.
Before you change this mode, consider the following:
• Changes to failover mode affect all appliances on your network. You cannot set this
mode for individual appliances.
• The WebSocket failover mode feature requires appliance version 9.4.2.0 or later. Appli-
ances on earlier versions remain in Legacy mode. Changing the failover mode on this
dialog box does not affect Legacy mode on these appliances.
• Faster WebSocket failover requires greater resource utilization (such as with CPU or
bandwidth).
Field Description
3. Click Save.
Changes to failover mode are orchestrated. Updates can take a while to propagate across
the network. Appliances will rebuild direct WebSocket connections.
Field Description
Orchestrator
The menus under Orchestrator are used to manage Orchestrator itself, and are not related
to managing appliances. The menus under this section are organized as follows:
• Orchestrator Server
• Software & Setup
• Aruba Central
For details, refer to the HPE Aruba Networking Orchestrator High Availability Installation and
Deployment Guide.
Use the Orchestrator High Availability tab from primary or backup Orchestrator instances to
view the HA modes of all Orchestrator instances in the HA cluster and their check-in statuses.
You can also use the tab to:
• Set up email notifications to be sent when Orchestrator instances do not make health
status updates to the database (from the primary instance only).
• Configure Orchestrator HA cluster reachability (from the primary instance only).
• Promote a backup Orchestrator to primary when the current primary Orchestrator is
down (from backup instances only).
• Decommission an Orchestrator instance (from the primary instance only).
Field Description
Instance Name of the Orchestrator instance you are currently accessing. The current
name build version is indicated.
Current HA HA mode of the Orchestrator instance you are currently accessing (Primary
mode or Backup).
HA regis- Timestamp indicating when the Orchestrator instance you are currently
tration accessing initially connected to the database.
time
Instance Name of the Orchestrator instance. The current build version is indicated.
Name
HA Mode HA mode of the Orchestrator instance (Primary or Backup).
IP IP address for the Orchestrator instance.
Registration Timestamp indicating when the Orchestrator instance initially connected to
Time the database.
Field Description
Check-in Indicates the health status of the Orchestrator instance (whether the
status instance can check in to the database). Each Orchestrator checks in to the
database every ten seconds. Statuses are:
1. Ensure that you are logged in to the primary Orchestrator instance. You cannot set up
email notifications from a backup instance.
2. On the Orchestrator High Availability tab, click Email Notification.
The Email Notification dialog box opens.
Field Description
Field Description
Check-in failure Number of minutes that healthy Orchestrators wait to send an email
time threshold notification after an Orchestrator instance fails to check in. The
notification includes the statuses of all registered instances. The
default is 2. You can specify a number from 1 to 30.
5. Click Save.
• Assign a default IP address or domain name to each Orchestrator instance. If the Orches-
trator IP address is private, you must provide a reachable IP address so that appliances
can communicate with it. Appliances will use this reachable IP address to reach Orches-
trator by opening a direct web socket to the Orchestrator.
• Assign IP addresses or domain names to each Orchestrator instance for specific appli-
ance interface labels. You can set a priority to these label-specific connections. Use this
option if the appliance needs to communicate to Orchestrator using a WAN interface
over a private network.
1. Ensure that you are logged in to the primary Orchestrator instance. You cannot configure
reachability from a backup instance.
2. On the Orchestrator High Availability tab, click Orchestrator Cluster Reachability.
The Orchestrator Cluster Reachability dialog box opens.
3. For default reachability, specify a default IP address or domain name for each Orches-
trator instance listed in the Default Orchestrator IPs or Domain Names area.
4. For reachability by interface label:
5. Click Save.
1. Ensure that the current primary Orchestrator is down or has been properly shut down
so that the VM is not running.
This dialog box provides status information for the current primary Orchestrator.
NOTE: If the current primary instance has a Reachable status rather than an Unreachable
status as shown above, you cannot proceed to promote the backup instance to primary.
Only one Orchestrator can be working as primary at any given time. Ensure that the
previous primary is completely down before promoting a backup.
4. To promote the backup Orchestrator to primary, click Promote to Primary.
A confirmation dialog box opens.
5. To proceed, click Promote to Primary.
The backup Orchestrator will restart in ten seconds and will be in Primary mode. This
new primary Orchestrator will function fully, the same as the previous one did.
1. Ensure that the Orchestrator instance you want to decommission is completely shut
down.
2. Log in to the primary Orchestrator instance. You cannot decommission Orchestrators
from a backup instance.
3. On the Orchestrator High Availability tab, click the X in the far-right column of the row
associated with the Orchestrator instance you want to decommission.
A confirmation dialog box opens.
4. Confirm that you want to decommission the instance.
Orchestrator Users
Orchestrator > Orchestrator Server > Users & Authentication > Orchestrator Users
Use the Orchestrator Users dialog box to manage who has Read-Write or Read-Only access to
Orchestrator.
Add a User
• Users can have either Read-Write or Read-Only privileges. These provide prescribed
access to Orchestrator menus.
To further limit the what users can see, you can assign them to customized menu groups
in Orchestrator > User Menu Access.
• Multi-Factor Authentication (MFA) is a recommended option for each Orchestrator user.
• A username cannot be more than 512 characters long.
NOTE: You cannot modify a Username. You must delete it and create a new user.
1. Navigate to Orchestrator > Orchestrator Server > Users & Authentication > Orches-
trator Users.
2. Click Add.
The Add User dialog box opens.
3. Complete the fields and click Add.
Multi-Factor Authentication
Orchestrators support Multi-Factor Authentication (MFA) on all platforms, including cloud and
on-premise versions. For cloud versions of Orchestrator, MFA is required. For on-premise
deployments, MFA is available but not required.
The first step in authentication is always username/password. For added security, users can
choose between application- or email-based authentication, as described below.
NOTE: Only users whose role is assigned Read-Write privilege for Orchestrator Users can en-
able or disable MFA for any user.
Orchestrator supports applications that provide time-based keys for two-factor authentication
and are compliant with RFC 4226 / RFC 6238. Google Authenticator is one such app. The
example below uses Google Authenticator on a mobile phone. You can also use a desktop
version.
To enable MFA through an application:
1. Navigate to Orchestrator > Orchestrator Server > Users & Authentication > Orches-
trator Users, and then click your username.
2. In the Two Factor field, select Application. Orchestrator generates a time-limited QR
code.
3. In the Google Authenticator app, use the Scan barcode function to read the QR code.
You will be prompted to enter your Orchestrator username and password.
Here you can see Google Authenticator with the new account added for the Orchestrator.
1. Navigate to Orchestrator > Orchestrator Server > Users & Authentication > Orches-
trator Users, and then click your username.
2. In the Two Factor field, select Email, and then enter your email address.
If an invalid email address is entered, the account could be locked out and would require
password reset procedures.
3. Click Add. Orchestrator sends a time-limited authentication code to your email address.
To verify your email address, click that link.
Orchestrator then opens a browser window telling you that your email address has been
verified.
After MFA is configured, every login requires two steps: entering the username/password and
entering the current token.
Based on the authentication method you choose, do one of the following:
• Use the current token from the Google Authenticator (or other) app.
• Use the code you receive in email.
Modify a User
1. Navigate to Orchestrator > Orchestrator Server > Users & Authentication > Orches-
trator Users.
2. Click the edit icon for the user you want to modify.
The Modify User dialog box opens.
• User Name is the identifier the user uses to log in, and it cannot be more than 512
characters long.
• First Name, Last Name, and Phone Number are optional information.
• Email is required if two-factor authentication is enabled.
• Two-factor Authentication is a second step in the login process that requires an
authentication code. The code can be obtained in two ways:
– Using an authentication application that generates time-based authentication
codes. If this is activated, Orchestrator generates a barcode that can be scanned
to set up an authentication app like Google Authenticator for your mobile de-
vice.
– Using your email to receive authentication codes every time you log in. This
requires access to your email every time you log in.
• Password is used at login.
• Status determines whether the user can log in.
• Role determines the user’s permissions.
• To enable Interop API support, navigate to Orchestrator > Software & Setup > Setup >
Advanced Properties and set the enableLegacyApisSupport property to true.
NOTE: It is recommended that you restart Orchestrator during a maintenance window.
• RBAC settings affect users accessing the Orchestrator UI as well as the Orchestrator REST
APIs, regardless of whether authentication is via login/password (role associated with the
user) or via an API key (role associated with the API key).
• For RBAC users, the RBAC filter will be applied to any Interop Orchestrator REST API calls
(for releases before 9.3.0).
NOTE: For non-RBAC users, the RBAC filter is disabled or will not be applied.
• An API endpoint (rbac/legacyApi) has been introduced to add an Interop API pattern that
is not already in the Interop list (see Pre 9.3 API Endpoints. You must test and verify that
the pattern in the database does not create issues.
• REST request performance will be impacted due to increased latency in request filtering
and routing of Interop REST APIs. It is recommended that all scripts be modified to adapt
to the Orchestrator 9.3 REST API endpoints.
For information about enabling Interop API support, see Orchestrator Advanced Properties.
For information about using Interop APIs, see Pre 9.3 API Endpoints.
Roles
Orchestrator provides a set of default roles. You can create new roles or modify an existing
role.
Field Description
To add a role:
1. Click Manage RBAC Roles. The RBAC Roles dialog box opens.
2. Click Add to create a new role, or click the Edit icon to the left of any existing role.
3. Enter or modify the role name.
4. Select a category you want to assign to your user from the following tabs: Monitoring,
Configuration, Administration, Orchestrator, Support, or Miscellaneous.
5. To assign the overall access level for the role, select Read Only or Read & Write.
6. Select the check box corresponding to the Orchestrator menu options you want to make
available to the role.
NOTE: You can Select All or Clear All.
7. Click Save.
Appliance Access
With appliance access groups, you can restrict appliance access to one or more groups or
regions. Complete the following steps to customize appliance access.
1. On the Role Based Access Control tab, click Manage Appliance Access Groups. The
Appliance Access Groups dialog box opens.
2. Click Add to create a new group, or click the Edit icon to the left of any existing group.
The Appliance Access Group dialog box opens.
3. Add or modify the name of the appliance access group.
4. Choose how you want to add appliances: Select Groups or Select Regions. You can
manually select groups or regions to include, or use the buttons to select or clear all
options.
5. Click Save.
WARNING: A non-RBAC user or an RBAC user with appliance access and no assigned role has
access to the Appliance Manager, CLI Session, and Broadcast CLI. An RBAC user with any role
assigned is denied access to the Appliance Manager, CLI Session, and Broadcast CLI.
Appliance
User Access Roles? Menu Options
1. On the Role Based Access Control tab, click Assign RBAC Roles & Appliance Access
Groups.
2. In the User field, enter the name of an existing Orchestrator user.
3. In the Appliance Access Group field, select the name of an existing Appliance Access
Group.
4. Select the check boxes for one or more roles you want to assign to the user.
5. Click Save.
The following table defines the roles provided by default in Orchestrator (roles are listed al-
phabetically).
Role Description
Role Description
Authentication
Orchestrator > Orchestrator Server > Users & Authentication > Authentication
Use the Authentication dialog box to manage different remote authentication methods for
Orchestrator users.
• RADIUS
• TACACS+
• OAuth
• JWT
• SAML
Field Description
2. Under Servers, enter the information for a Primary server of that type. Entering a Sec-
ondary server is optional.
Field Description
Authentication Order Whether to use the remote map or the local map first. The
default is Remote first.
Prerequisites
• The OAuth server must support OAuth 2.0 authorization codes, ID tokens, and (option-
ally) refresh tokens.
• The ID token is used to get username, RBAC roles, and RBAC appliance access groups.
• The refresh token can be checked periodically to ensure that the user is still authorized.
• Depending on the OAuth server configuration, refresh tokens can be permanent or they
can expire. If a token is revoked or expires, the user is forced to authenticate again.
Before adding an OAuth server in Orchestrator, register a new app on your OAuth server for
Orchestrator. Provide the following details when registering the app:
When adding a new OAuth server or modifying an existing server, configure the following fields
in the Remote Authentication Server dialog box:
Field Description
Field Description
(Optional) Roles key This field can be left with the default value, ec-roles, or you
can enter a new key name, but the key name must match
what is configured in your OAuth provider.
• Issuer ‘iss’
• Auditor ‘aud’
• expiration ’exp
• signature
• user, role, and AAG
Review the following diagram for more details about the workflow of JWT authentication.
1. Navigate to the Authentication dialog box in Orchestrator (Orchestrator > Users &
Authentication > Authentication).
2. Click +Add New Server.
The Remote Authentication Server dialog box opens.
3. From the Type drop-down menu, select JWT, and then complete the following fields.
Field Description
Field Description
Roles key This field can be left with the default value, ec-roles, or you
can enter a new key name, but the key name must match
what is configured in your JWT provider.
• IdP: Okta
• SP: Orchestrator
• Principal: A principal end user
14. In Orchestrator, configure the following attributes on the Remote Authentication Server
dialog box.
NOTE: For each attribute, you must click in the field and enter the text for the value. If
you click Save without entering any text, no value is saved and the field remains empty.
15. Navigate to the Okta SAML Settings dialog box, and in the Attribute Statements (optional)
section, create the following attributes and corresponding values.
ec-name user.email
ec-roles user.usertype
ec-aag user.department
NOTE: The roles that these claims map to in Orchestrator are configured and assigned
to users on the RBAC tab in Orchestrator (Orchestrator > Orchestrator Server > Users
& Authentication > Role Based Access Control (RBAC)).
16. Make sure the attribute names match in both applications.
NOTE: The attribute names you enter in the SAML provider (Okta) must exactly match
the attribute names you created in Orchestrator, including character case.
17. Click Next.
18. Click Finish.
19. On the completed SAML settings page, click View SAML setup instructions.
20. Copy and paste the URLs from the following Okta fields into the corresponding Orches-
trator fields.
21. In Orchestrator, click Save to save the changes you made on the Remote Authentication
Server dialog box.
A message at the bottom of the screen notifies you that you have successfully created
SAML server configuration.
The following table provides more details about the fields in Orchestrator.
NOTE: Okta supports assigning the attributes at the group level. Refer to either Okta docu-
mentation or your Okta administrator for more information.
Field Description
Field Description
(Optional) Appliance Access This field can be left with the default value, ec-aag, or
Group Attribute you can enter a new key name, but the key name
must match what is configured in your OAuth
provider.
API Key
Orchestrator > Orchestrator Server > Users & Authentication > API Keys
Use this page to allow your applications to utilize REST APIs without session authentication
and management. You can specify permissions, status, name, and IP allow list for your API
keys.
An API key can be passed either in the HTTP request header field X-Auth-Token or as a query
parameter apiKey.
NOTE: It is recommended to use different keys for different applications and users.
To add and define a new API key, click the Edit icon and configure the fields below.
Field Description
Cloud Portal
Configuration > Overlays & Security > Licensing > Cloud Portal
Orchestrator > Orchestrator Server > Licensing > Cloud Portal
The Cloud Portal dialog box is used to register cloud-based features and services, such as SaaS
optimization and EdgeConnect.
NOTE: Orchestrator 9.5.2 and later supports IPv6 and IPv4. To support IPv6, the Cloud Por-
tal URL changed to portal2.silverpeak.cloud. See the Orchestrator 9.5.2 release notes for de-
tails.
NOTE: If you enabled Air-Gap mode, you cannot access the Cloud Portal. You will log in to
the Air-Gap Portal to generate a new account key, which you will provide on this dialog box.
Follow the instructions for enabling Air-Gap and accessing the Air-Gap Portal here: HPE Aruba
Networking Orchestrator Air-Gap User Guide.
• When you purchase one of these services, an Account Name and instructions to obtain
your Account Key are sent to you. You will use these to register your appliances.
• Use of these services requires that your appliances can access the Cloud Portal via the
Internet.
• You can require hardware appliances to be provisioned with the Account Name and Ac-
count Key in order to be discovered.
• You can register a secondary account using the Secondary Accounts button.
• If you subscribed to an AAS License, the license type is displayed. The AAS license sub-
scription determines which features are available in Orchestrator. The license token is
refreshed from Cloud Portal every 24 hours.
• The Orchestrator UUID (universally unique identifier) is available under the Registration
heading on the Cloud Portal dialog box.
Secondary Accounts
Secondary accounts allow you to manage multiple license end dates across a single SD-WAN,
and can be used in the following situations:
• You want to add an account that has a different end date from the existing primary ac-
count in your Orchestrator.
• You want to merge accounts from one Orchestrator to another Orchestrator and have
one SD-WAN fabric to manage.
NOTES:
- Hardware assets must co-reside in the same secondary account where the license resides.
- It is recommended to co-terminate licenses when possible for ease of management.
The primary account is where Orchestrator resides, and secondary accounts are associated
to Orchestrator through the registration process. Hardware must reside in the same account
as the software licenses associated with that hardware. You can register up to 11 secondary
accounts.
As with a primary account, an Account Name and instructions to obtain your Account Key are
sent to you. You will use these to register your appliances to the secondary account. To add a
secondary account click Secondary Accounts, then click +Add, enter the account information,
and click Add. To register the added secondary account, click Save.
Any secondary account changes, such as adding, updating, or deleting accounts, will trigger
the registration process for all secondary accounts, even for those not modified directly in
Orchestrator. This will be evident when a spinning icon is displayed next to “Registered” af-
ter saving any changes. After the registration process is complete, the spinning icon will be
replaced with registration information that Cloud Portal returns to Orchestrator.
Air-Gap Tab
Orchestrator > Orchestrator Server > Licensing > Air-Gap
Use the Air-Gap tab to enable Air-Gap mode and complete Air-Gap registration.
The HPE SD-WAN Orchestrator Air-Gap solution provides a deployment option that allows
you to deploy HPE Aruba Networking EdgeConnect SD-WAN in an isolated network environ-
ment with no internet connectivity. With the EdgeConnect SD-WAN product running in Air-
Gap mode, appliance activation, license management, and other supporting functions are
performed through the Air-Gap Portal where authorized customers can manually exchange
information between HPE Aruba Networking Cloud Portal and the customer’s EdgeConnect
SD-WAN deployment, removing the requirement of an internet connection.
The HPE Aruba Networking Orchestrator Air-Gap solution is only available for self-hosted Or-
chestrator deployments.
IMPORTANT: Once Air-Gap mode is enabled, it cannot be disabled. Only Silver Peak Support
can disable Air-Gap mode.
Audit Logs
Orchestrator > Orchestrator Server > Tools > Audit Logs
The Audit Logs tab lists actions from a user or the system itself, initiated by Orchestrator.
You can apply the following filters to your audit logs:
• To determine which actions you want to display in the table, select Completed, In
Progress, or Queued filters.
• Select the following different log levels to apply to your filter: Debug, Info, or Error.
• To refresh or pause the table, select either Auto Refresh or Pause. By default, the table
refreshes automatically.
• Enter the Record Count to limit the filtering criteria. The default value is 500, and the
maximum value is 10,000.
• Select the name of the Appliance from the lists to apply as a filter.
• You can search a wild card character (*) as a username to display all user logs. If you
enter any value in the user field, no filter is applied to the search. The following are true
for audit log wild cards:
Field Description
User Name Filter/search for an audit log by the username of the appliance.
IP Address IP address of the selected appliance.
Appliance Name of the appliance the audit log comes from.
Action The action that was taken by the user or the system, initiated by
Orchestrator.
Task Status Status of the audit log task.
Results Contains a brief description of the audit log including any actions
taken. If the audit log refers to template changes or segment (VRF)
firewall zone policy changes, any comments entered in the Audit Log
Comment field will be included in the description. Click the cell to
view the full description.
Field Description
Start Time Time when the search of the audit log started.
End Time Time when the search of the audit log ended.
Queued Time Time when the process/task was requested or scheduled in the
queue.
% Completed Percent completed of the audit log task.
Completion Status Whether the task has been completed.
Orchestration Settings
Orchestrator > Orchestrator Server > Tools > Orchestration Settings
The Orchestration Settings dialog box manages Business Intent Overlays (BIOs) and the prop-
erties that control them. It builds new tunnels and fixes existing ones.
Field Description
Field Description
NOTE: Click the first Reset to Defaults button to reset the above settings to the defaults.
IPSec UDP Settings
Field Description
Default port By default, BIOs create IPSec UDP tunnels. The default port is 10002.
If necessary, you can configure this for an individual appliance on its
System Information page, under System Settings. This is accessible
from the appliance’s context-sensitive menu in the Orchestrator
navigation pane.
Increment port by Referenced when configuring an EdgeHA pair. When the value is
1000, the second appliance’s default port becomes 11002.
NOTE: Click the second Reset to Defaults button to reset the IPSec UDP settings to the de-
faults.
Maintenance Mode
Orchestrator > Orchestrator Server > Tools > Maintenance Mode
You can set maintenance mode on an appliance in two ways. You can:
• Use the menu available from the appliance tree. This method automatically suppresses
alarms and pauses orchestration.
• Use the Orchestrator menu to select appliances and specify settings. This method allows
you to specify whether to pause orchestration or suppress alarms.
Set Maintenance Mode Using the Menu Available from the Appliance Tree
1. Right-click on one or more appliances in the appliance tree, and then select Mainte-
nance Mode.
The following table describes the fields on the Maintenance Mode dialog box.
Field Description
• GCM-128
• GCM-256
• GMAC-128
• GMAC-256
Each preset includes a predetermined set of IKE and ESP (IPSec) cryptographic algorithms. By
selecting an IPSec Suite B preset, you can streamline the algorithm aspect of your tunnel setup
rather than selecting individual algorithms. However, you can select individual algorithms if
you want to. To select a preset, use the IPSec Suite B Preset drop-down field on the General
tab.
The following tables show the IPSec Suite B presets in the header row and provide the associ-
ated algorithm setups for the IKEv2 and ESP (IPSec) stages.
IKEv2 Stage
Notice in the second table that the encryption and data authentication is done in one step for
GCM. For GMAC, there is no encryption.
General Tab
Access the following fields by clicking the General Tab.
General
Field Description
NOTES:
Packet
NOTE: FEC settings do not apply when overlays are used. FEC settings only apply when routing
directly to an underlay via Route Policy.
Field Description
Reorder wait Maximum time (in milliseconds) the appliance holds an out-of-order
packet when attempting to reorder. 100 ms is the default value and
should be adequate for most situations. FEC can introduce out-of-order
packets if the reorder wait time is not set high enough.
FEC Forward Error Correction (FEC) can be set to enable, disable, or auto.
FEC ratio When FEC is set to auto, FEC will range dynamically from off to 1:10 based
on detected loss. The options are 1:1, 1:2, 1:5, 1:10, or 1:20. This field is
available only if FEC is set to enable.
Tunnel Health
Field Description
Retry count Number of failed keep-alive messages allowed before the appliance brings
the tunnel down.
DSCP Determines the DSCP marking that the keep-alive messages should use.
FastFail Thresholds
NOTE: FastFail thresholds do not apply when overlays are used. FastFail only applies when
routing directly to an underlay via Route Policy.
Field Description
Fastfail enabled When multiple tunnels are carrying data between two
appliances, this feature determines how quickly to disqualify
a tunnel from carrying data.
Base = 200mS
N = 2
then,
RTTavg = 50mS
Field Description
IKE Tab
Access the following fields by clicking the IKE tab. This tab is displayed only if the Mode field
on the General tab is set to IPSec.
IKE
Field Description
Peer Authentication There are two options for IKE authentication, End entity
certificate or Pre-shared key, choose one of the options. End
entity certificate is the recommended option.
If the IPSec Suite B Preset field is set to any other setting, this
field is automatically set to the appropriate algorithm.
Field Description
Encryption algorithm Encryption algorithm used for IKE security association (SA).
If the IPSec Suite B Preset field is set to any other setting, this
field is automatically set to the appropriate algorithm.
Pseudo Random This field is displayed only if the IKE Encryption Algorithm field
Function is set to AES-GCM-128 or AES-GCM-256.
If the IPSec Suite B Preset field is set to any other setting, this
field is automatically set to the appropriate group.
Rekey interval/lifetime Rekey interval/lifetime of IKE security association (SA) in
minutes. The default is 360 minutes.
Dead peer detection Delay time: Interval (in seconds) to check the lifetime of the
IKE peer.
Field Description
Phase 1 mode Exchange mode for the IKE security association (SA)
negotiation.
If the IKE Version field is set to IKE v1, you can select Main or
Aggressive.
If the IKE Version field is set to IKE v2, this field is automatically
set to Aggressive.
IKE version If the IPSec Suite B Preset field on the General tab is set to
None, you can select IKE v1 or IKE v2.
If the IPSec Suite B Preset field is set to any other setting, this
field is automatically set to IKE v2.
IPSec Tab
Access the following fields by clicking the IPSec tab. This tab is displayed only if the Mode field
on the General tab is set to IPSec or IPSec UDP.
IPSec
Field Description
Field Description
Encryption algorithm Encryption algorithm used for the IPSec security association
(SA).
If the IPSec Suite B Preset field is set to None, and the IPSec
Authentication algorithm field is set to AES-GMAC-128 or
AES-GMAC-256, this field is automatically set to NULL.
IPSec anti-replay window Select a size from the drop-down list or Disable to disable
the IPSec anti-replay window. If a size is selected, protection
is provided against an attacker duplicating encrypted
packets by assigning a unique sequence number to each
encrypted packet.
Relay interval/lifetime Rekey interval/lifetime of the IPSec security association (SA)
in minutes. The default is 360 minutes.
Perfect forward secrecy Diffie-Hellman group used for IPSec security association
group (SA) negotiation. Based on the setting of the IPSec Suite B
Preset field on the General tab, this field is set to the
following Diffie-Hellman group:
You can use a blueprint when creating a new Orchestrator or when migrating an existing Or-
chestrator to on-prem or cloud.
• Blueprints can only be created from Orchestrators that have no appliances associated
with them. If the source Orchestrator manages any appliances, blueprint creation fails.
• You can create and store multiple blueprints with the same Orchestrator.
• After creating as many blueprints as you need, you can add appliances to the source
Orchestrator.
• Blueprints automatically exclude all statistics, large historical data files (including audit
logs, report histories, and so forth), and account information.
1. In the Orchestrator Blueprint Export dialog box, select the blueprint type: Template or
Migration
• Blueprint Template mode - In this mode, IPSec UDP key is not included in the ex-
porting. MTO uses Blueprint Template to create new orchestrators.
• Blueprint Migration mode - In this mode, IPSec UDP key is included in the exporting.
This works as making clones on an orchestrator.
Brand Customization
Orchestrator > Orchestrator Server > Tools > Brand Customization
Use this dialog box to customize the branding aspects of the Orchestrator user interface.
Depending on your environment, you can upgrade Orchestrator in either of the following
ways:
NOTE: Upgrading via SCP is only available for versions 8.10.20 and later.
If you have an HTTP URL to the Orchestrator installation file, enter the following in the existing
SSH console to run the install script and point it to the hosted installation file:
/home/gms/gms/setup/install_orchestrator.sh <HTTP URL of the Orchestrator Installation
File>
If you do not have an HTTP server, copy the Orchestrator installation file to Orchestrator by
using SCP, run the install script, and point it to the local installation file.
NOTE: This procedure assumes that the scp programs on both ends are patched for CVE-2020-
15778 and/or you trust the remote server from which you will scp the installation file. From
the Orchestrator SSH console, enter the following as root:
1. From the Orchestrator SSH console, enter the following: mv /bin/scp-local /bin/scp #
2. From your local PC console, do one of the following:
• If you are running Orchestrator release 9.1.9, 9.2.10, 9.3.3, 9.4.x, or later, do the
following:
1. Enter scp <Orchestrator Installation file> admin@<orchestrator_ip_address
>:/home/admin
3. From the Orchestrator SSH shell console, enter chown gms.gms /home/gms<
Orchestrator Installation file>
• If you are running an Orchestrator release earlier than those listed above, enter scp
<Orchestrator Installation file> admin@<orchestrator_ip_address>:/home/gms
3. From the Orchestrator SSH shell console, enter the following: /home/gms/gms/setup/
install_orchestrator.sh <full_path_to_Orchestrator_Installation_file>
1. Using Orchestrator in the cloud, navigate to Orchestrator > Software & Setup > Up-
grade > Upgrade Orchestrator.
The Upgrade Orchestrator dialog box opens.
2. Click in the Select Version field to display a drop-down list of Orchestrator versions you
can upgrade to, and then select the appropriate version.
3. Click Upgrade.
You will receive an email message indicating that the Orchestrator version upgrade has
started. Orchestrator service is not available during the upgrade process. When the pro-
cess completes, you will receive another message indicating that the upgrade was suc-
cessful. If a failure occurs, however, you will receive a failure message with instructions
to contact HPE Networking support.
Back Up on Demand
Orchestrator > Software & Setup > Backup > Backup Now
Use this dialog box to back up the Orchestrator database on demand.
Field Description
Field Description
Field Description
View Currently Scheduled Jobs Click to open the Scheduled Jobs tab.
Use Orchestrator backup Select this check box to back up the Stats Collector using
configuration the same destination and schedule set in the Schedule
Orchestrator Backup dialog box. For more information,
see Schedule Orchestrator Backup.
Protocol Protocol to apply: FTP, SCP, HTTP, HTTPS, or SFTP.
Hostname Host name of the backup server.
Username Username that the Orchestrator server uses to log in to
the backup server.
Password Password for the username.
Directory Directory name of the backup server.
Port Port number of the backup server.
Max backups to retain Maximum number of backups to retain.
Test To verify that Orchestrator can reach the destination,
click Test.
Field Description
• If a test email does not arrive within minutes, check your firewall.
• After configuring the SMTP settings, you can specify email recipients for the following:
Proxy Configuration
Orchestrator > Software & Setup > Setup > Proxy Configuration
If necessary (for example, because of firewall issues), you can configure a proxy for reaching
the Cloud Portal.
1. After the certificate is uploaded on the End Entity Certificates tab, navigate to Orches-
trator > Software & Setup > Setup > HTTPS Certificate.
The HTTPS Certificate dialog box opens.
2. Click Use End Entity Certificate.
3. Select the label for the certificate you uploaded from the End Entity Certificate drop-
down menu.
4. Click Save.
NOTE: After saving, you must manually restart Orchestrator for the web server to pick up the
new certificate.
NOTE: To have the EdgeConnect appliance verify the Orchestrator certificate, you must click
the Verify Orchestrator Certificate check box on the Advanced Security Settings dialog box.
To do this, navigate to Configuration > Overlays & Security > Advanced Security Settings.
The other method (legacy method) requires everything to be done externally including cre-
ating the public key private key pair and creating the CSR. This legacy method is not recom-
mended.
To use the legacy method with Orchestrator:
1. Consult with your IT security team to generate a certificate signing request (CSR), and
submit it to your organization’s chosen SSL Certificate Authority (CA).
• Navigate to Orchestrator > Software & Setup > Setup > HTTPS Certificate.
• If your IT security team advises the use of an Intermediate CA, use an Intermediate
Certificate File. Otherwise, skip this file.
• Load the Certificate File from the CA.
• Upload the Private Key File that was generated as part of the CSR.
3. To associate the CA verified certificate for use with Orchestrator, click Upload.
NOTE: To have the EdgeConnect appliance verify the Orchestrator certificate, you must click
the Verify Orchestrator Certificate check box on the Advanced Security Settings dialog box.
To do this, navigate to Configuration > Overlays & Security > Advanced Security Settings.
IP Allow List
Orchestrator > Software & Setup > Setup > IP Allow List
IP Allow List is a feature that restricts access to Orchestrator to a specified list of source sub-
nets.
If a source IP address changes (for example, with NAT IP), users can get locked out of Orches-
trator.
To view a list of traffic that has been dropped because of these restrictions, click IP Allow List
Drops.
The wizard guides you through the basics of configuring the following:
Setting Description
If you do not click Apply after you complete the last page, the Orchestrator wizard reappears
at your next login.
To access the Orchestrator wizard again after initial configuration, navigate to Orchestrator
> Software & Setup > Setup > Configuration Wizard.
• The Date/Time template sets the time and time zone for the appliance. Make sure the
proper Date/Time template is applied to the appliance. If the appliance does not have
the proper template applied, business hours set on the Availability Time Settings tab will
be inaccurate.
• Reports are tied to calendar months (not the last 30 days) and calendar day boundaries.
• Availability trends charts display data with the Coordinated Universal Time (UTC) times-
tamp.
1. Select an appliance in the table, and then complete the following fields as appropriate.
Field Description
Time Zone Availability time zone for the appliance. Select one of the
following:
A listed time zone – If the time zone you select is different than
the appliance’s uniquely configured time zone, this setting will
override the appliance’s time zone.
Field Description
Business Hours Availability business hours for the appliance. Select one of the
following:
2. Click Save.
Statistics Retention
Orchestrator > Software & Setup > Setup > Statistics Retention
This tab displays all the statistics Orchestrator collects from appliances. Orchestrator saves
the statistics data in a database with the retention policies defined on this tab.
To begin, complete the following steps:
1. Click the Edit icon in the table next to the statistic you want Orchestrator to collect.
2. To enable or disable statistics collection, select the Collect this statistic in Orchestrator
check box.
3. Enter how long you want Orchestrator to retain the statics for Minute Granularity,
Hourly Granularity, and Daily Granularity before it collects data and stores in the par-
tition.
TIP: If you click More Options, you can enter values for the Database Duration.
4. Click Apply.
Field Description
Field Description
Daily Granularity (months) Amount of time in one day Orchestrator stores data.
Estimated Disk Space Estimated amount of disk space the selected statistic uses. At
the bottom of the screen, you can get an estimated disk space
required for a number of appliances, overlays, and tunnels.
DoS Stats
You can monitor your network behavior based on the Firewall Protection Profile (FPP) settings
and the thresholds you set. The denial of service (DoS) statistics described in the following
table provide visibility into the statistics for all Firewall Protection Profiles that are configured
and mapped to zone/segment pairs. DoS statistics help you tune FPP settings with the right
thresholds, identify violating sources, enable response actions, and so on.
Orchestrator retains statistics related to DoS services on appliances for 30 days. If you re-
quire longer retention periods, you can purchase a Storage subscription. See your HPE Aruba
Networking representative for details.
Zone Level - Total Drop Count: The total number of flows dropped at
the zone level. For real-time statistics, stats are collected every second.
For historical statistics, stats are collected every 5 minutes.
Zone Level - Min Threshold Exceed Count: The total number of times
the Min Threshold was exceeded at the zone level. For real-time statistics,
stats are collected every second. For historical statistics, stats are
collected every 5 minutes.
Zone Level - Max Threshold Exceed Count: The total number of times
the Max Threshold was exceeded at the zone level. For real-time statistics,
stats are collected every second. For historical statistics, stats are
collected every 5 minutes.
Zone Level - Total Error Drop Count: Total number of error drop counts
collected at the zone level. For real-time statistics, stats are collected
every second. For historical statistics, stats are collected every 5 minutes.
Ddostoptalkers The top 50 IPs that used the most number of concurrent flows, embryonic
flows, and flows per second (FPS) and the top 50 IPs that violated the
minimum and maximum thresholds. This statistic is common for all zones
and is refreshed every hour.
NOTE If there are more IPs than the list can support, IPs in this list will be
replaced resulting in some IPs getting dropped from the hourly top
talkers list.
Ddossrcipsample10A list of 10 sample source IPs that exceed the minimum threshold and
maximum threshold set in Firewall Protection Profile for concurrent,
embryonic, and FPS metrics respectively. These are historical stats (not
real-time). These stats are not zone-specific. Sample IPs are from
zone/segment pairs where FPP is configured. These stats are updated
every 5 minutes.
Ddospeakandpeakdroprate
Includes the following:
Peak stats for IPs and Counts are collected for the FPS, concurrent flows,
and embryonic flows metrics every one second for all protocols. These
stats report the highest number for Ddostotalstats, Ddostoptalkers, and
Ddossrcipsample10. The metrics are each recorded in 5 minute intervals.
The peak drop rate stats report the highest flow drop rate per second that
occurred within the 5 minute interval. For real-time statistics, stats are
collected every second. For historical statistics, stats are collected every 5
minutes.
Stats Configuration
The Stats Configuration dialog box displays the parameters for the Statistics Retention.
WARNING: Changing the default values of these settings is not recommended without con-
sulting Support.
Click Advanced Properties to display the Stats Configuration dialog box. For more detail,
refer to the following table.
Field Description
Field Description
Field Description
• Local Stats Collector: Orchestrator and Stats Collector in a single VM. This is ideal for
deployments with less than 100 appliances.
• Remote Stats Collector: Orchestrator on a separate VM and Stats Collector on a differ-
ent VM (Orchestrator VM deployed in Stats Collector mode only). HPE Aruba Networking
recommends one Remote Stats Collector per 150 appliances.
The Distributed Stats Collector feature collects statistics from appliances and provides the
information to Orchestrator. When enabled, the Stats Collector runs in parallel with the Local
Stats Collector to collect the necessary historical statistical data. After collecting that data, you
can discontinue local stats collection. You will not experience performance improvement until
you discontinue legacy stats collection.
If you are running ECOS 9.1 or later and Orchestrator 9.1 or later, HPE Aruba Networking
recommends that you set up the Distributed Stats Collector so that you will be able to take
advantage of new stats that are introduced in future releases.
Prerequisites
• Both the Orchestrator and Stats Collector must be on the same release.
• Upgrade all appliances to version 9.1.0 before enabling the Distributed Stats Collector
feature.
• By default, when you install Orchestrator for the first time, Orchestrator automatically
creates a Local Stats Collector. The Local Stats Collector can accommodate a maximum
of 100 appliances. If you need to scale beyond 100 appliances, you must use the Remote
Stats Collector. (There might be some dependencies based on your deployed topology.)
Refer to the following table to determine the number of appliances per Remote Stats
Collector you will need for your topology.
Mesh Up to 150
Hub and Spoke Up to 300
• Each Stats Collector must meet the following virtual machine minimum requirements:
NOTE: If you have less than 100 appliances, you can use the predefined Local Stats Col-
lector. You do not need to perform the steps in Before You Begin.
1. Open an SSH session to the Orchestrator you want to use as a Stats Collector.
2. If prompted, enter the root password. If you do not know your root password, contact
Support.
3. Change to the /home/gms/gms directory:cd /home/gms/gms
4. To run the Orchestrator setup script, enter orch-setup -m, and then press Enter.
5. To select the stats collector only mode, at the prompt, enter s.
6. To proceed, enter y.
This VM is now a Stats Collector.
NOTE: Orchestrator and EdgeConnect appliances communicate with the Stats Collector
over HTTPS (port 443). Orchestrator and EdgeConnect appliances will raise alarm if the
Stats Collector is not reachable.
After you create and configure a Stats Collector, you must copy the Orchestrator public key
and paste it into the same folder on the Stats Collector, as follows. This will establish an HTTPS
connection with Orchestrator and the data from the Stats Collector to Orchestrator will be
encrypted.
Copy the Public Key File from Orchestrator to the Stats Collector
• For on-prem Orchestrator deployment: If you are running release 9.1.9, 9.2.10,
9.3.3, 9.4.x, or later, enter the following:
whoami
If the response is not gms, enter the following, and then provide the admin password.
sudo su - gms
2. Go to: cd /home/gms/sc/publickeys
3. To list the file that contains the public key, enter ls
4. Enter the followinig command to determine if you are running Rocky Linux:
cat /etc/redhat-release
5. Do one of the following to copy the public key file to your new Stats Collector.
NOTE: Depending on your underlying OS and security settings, the following SCP steps
might not work. If SCP does not work, copy the public key file using another file trans-
fer method, such as FTP, or you can manually copy the file (make sure to copy escape
characters) to the new Stats Collector in the /home/gms/sc/publickeys/ directory.
• If you are running Rocky Linux, enter the following command (you might need to
omit -O if your operating system does not support this parameter).
sudo scp -O <public_key_file_name.pub> admin@<new-Orch-IP>:/home/admin/
• If you are not running Rocky Linux, enter scp <public_key_file_name.pub> admin@<
remote_stats_collector_ip>:/home/gms/sc/publickeys/
where:
– public_key_file_name.pub is the name of the file listed in step 3. For example,
d1ab581df8c745b59eec548ef5a2f011.pub. The public key file name will be different
for each case.
• For on-prem Orchestrator deployment: If you are running release 9.1.9, 9.2.10,
9.3.3, 9.4.x, or later, enter the following:
whoami
If the response is not gms, enter the following, and then provide the admin password.
sudo su - gms
2. Enter the following command to determine if you are running Rocky Linux:
cat /etc/redhat-release
Complete the following tasks to create and install an end entity certificate for each Remote
Stats Collector.
NOTE: Skip this procedure if you did not install a custom HTTPS certificate on Orchestrator or
you are using the Local Stats Collector.
1. In Orchestrator, navigate to Configuration > Overlay & Security > Security > Custom
CA Certificate Trust Store.
2. Select Use Custom Certificate Store.
3. Click Add Default Certificates.
4. Click Add Certificate to Custom Trust Store.
The Add/Edit Custom Certificates dialog box displays.
5. Enter a meaningful Alias for the certificate in the Alias field. For example, “ClearPass_CA_Root”.
6. Paste the root certificate into the Certificate field.
7. Click Save.
8. Click Apply Changes.
9. Click Close.
IMPORTANT: After you add a root CA certificate to the Custom Trust Store, you must
restart Orchestrator from the CLI.
10. Enter the following commands from the CLI to restart Orchestrator.
ssh [email protected]
su
Create and Send the CSR in Orchestrator and Upload the Signed Certificate in Orchestrator
1. Create the CSR in Orchestrator. Follow the steps in Create a Certificate Signing Request
(CSR).
2. Send the CSR to your Certificate Authority to receive a signed certificate.
3. Obtain the signed certificate from the CA. Follow the steps in Obtain the Signed Certificate
From the CA.
4. After you receive the signed certificate, follow the steps in Upload the Signed Certificate
to the End Entity Certificate Tab to upload the signed certificate.
Proceed to Create and send the CSR in Stats Collector and upload the signed certificate in Stats
Collector.
Create and send the CSR in Stats Collector and upload the signed certificate in Stats Collector
You must create and send the CSR in Stats Collector and upload the signed certificate in Stats
Collector.
cd /home
default_bits = 1024
distinguished_name = req_distinguished_name
req_extensions = SAN
extensions = SAN
[ req_distinguished_name ]
commonName = xx.xx.xx.xx
countryName = US
stateOrProvinceName = CA
organizationName = HPE
organizationalUnitName = Aruba
[SAN]
#authorityKeyIdentifier=keyid,issuer
#basicConstraints=CA:FALSE
subjectAltName = IP:xx.xx.xx.xx
5. Use SCP to copy the new CSR from the Remote Stats Collector to your laptop.
NOTE: If you cannot copy the new CSR via SCP, you can create a new file with the same
name on your laptop and copy the contents into the new file.
6. Send the CSR file that you copied in step 5 to your Certificate Authority for signing.
7. Obtain the signed certificate from the CA.
When you receive the signed certificate from the CA, if there are multiple files you need
to combine all the files into a single file, which includes the end entity certificate, all in-
termediate CA certificates, and the root CA certificates. This is necessary because you
must upload the entire certificate chain in Orchestrator as a single file. The sequence of
certificates in the single-file chain is important and should be as follows:
1. End entity certificate (top of file)
2. One or more certificates of the intermediate CA(s)
3. Self-signed root CA certificate
You now have a signed end entity certificate for the Remote Stats Collector.
8. Rename the downloaded and signed end entity certificate scSignedCrt.pem.
9. Use SCP or Filezilla to transfer scSignedCrt.pem for the Remote Stats Collector from your
laptop to the /home directory on the Remote Stats Collector.
10. Log in to the Remote Stats Collector.
ssh [email protected]
cd /home
mv server.crt server_backup.crt
mv server.key server_backup.key
12. Enter the following command to move the private key you created while generating the
CSR from /home to /home/gms/gms/properties.
mv /home/newkey.key /home/gms/gms/properties/server.key
13. Enter the following command to move the signed end entity certificate for the Remote
Stats Collector from /home directory to /home/gms/gms/properties
mv /home/scSignedCrt.pem /home/gms/gms/properties/server.crt
15. After you restart the Remote Stats Collector, the new end entity certificate for the Remote
Stats Collector will be installed and the private key will be loaded. Run the following
command to verify the status of the Remote Stats Collector.
service sc status
1. Back up Orchestrator. For more information about backing up Orchestrator, see Back
Up on Demand.
Before you enable the Distributed Stats Collector feature and discontinue legacy stats
collection, it is recommended that you back up the Orchestrator database. Discontinuing
legacy stats collection is permanent. To return to your previous configuration, you must
restore the Orchestrator configuration backup.
2. Add a Stats Collector. If your network contains less than 200 appliances, you can use the
predefined Local Stats Collector.
3. Associate Appliances with a Stats Collector or Associate Appliances with the Predefined
Local Stats Collector
4. When the necessary historical data has been collected, Discontinue Legacy Stats Collec-
tion.
1. Navigate to Software & Setup > Setup > Stats Collector Configuration.
The Stats Collector Configuration tab opens.
2. Click Edit Stats Collectors.
The Edit Stats Collectors dialog box opens.
3. Click Add Stats Collector.
The Stats Collector dialog box opens.
4. Configure the following elements as needed:
Field Description
5. Click Save.
To delete an existing Remote Stats Collector, click the delete icon (X) in the last column of the
entry in the table.
1. Navigate to Software & Setup > Setup > Stats Collector Configuration.
The Stats Collector Configuration tab opens.
2. In the Orchestrator appliance tree, select one or more appliances to associate with a
specific Stats Collector.
WARNING: The statistics for an appliance are tied to the Distributed Stats Collector it is
associated with. If you associate an appliance with a different Distributed Stats Collector,
you lose all statistical data associated with that appliance.
3. Select the Add check box next to the Stats Collector you want to associate the selected
appliance(s) with.
4. Click Apply.
The Apply Changes dialog box opens.
5. Click Apply Changes.
If you are installing Orchestrator version 9.1.0 or upgrading to version 9.1.0 or later, Orches-
trator provides a default Stats Collector called local. You cannot edit or delete the Local Stats
Collector. You can associate up to 200 appliances with the Local Stats Collector.
NOTE: If you are upgrading to Orchestrator 9.1.0, all appliances will be automatically associ-
ated with the Local Stats Collector.
NOTE: If you run Orchestrator in Orchestrator Only mode (orch-setup -m o), the Local Stats
Collector will be disconnected.
To associate appliances with the Local Stats Collector:
1. Navigate to Software & Setup > Setup > Stats Collector Configuration.
The Stats Collector Configuration tab opens. This tab displays the Stats Collector config-
uration for all appliances selected in the appliance tree to the left.
2. In the Orchestrator appliance tree, select one or more appliances to associate with the
Local Stats Collector.
3. Select the Add check box next to the Local Stats Collector.
4. Click Apply.
The selected appliances are associated with the Local Stats Collector. The Changes col-
umn indicates the Stats Collectors that were added and removed.
After you associate appliances with either the Local Stats Collector or the newly added Stats
Collectors, you must enable the Distributed Stats Collector feature to begin collecting data.
NOTE: The legacy Stats Collector continues to collect statistics in parallel with the Distributed
Stats Collector feature until you discontinue legacy stats collection. For more information, see
Discontinue Legacy Stats Collection.
NOTE: The backslash (\) character is not allowed in any field in the Orchestrator > Software
& Setup > Backup > Schedule Stats Collector menu or the Orchestrator > Software & Setup >
Backup > Schedule Backup menu.
WARNING: You cannot disable the Distributed Stats Collector after you enable it. It is recom-
mended that you back up Orchestrator before you enable the Distributed Stats Collector. For
more information about backing up Orchestrator, see Back Up on Demand.
To enable the Stats Collector:
1. Navigate to Software & Setup > Setup > Stats Collector Configuration.
The Stats Collector Configuration tab opens.
2. Click Enable New Stats Collection.
The Enable New Stats Collection dialog box opens.
Before you can enable the Distributed Stats Collector feature, you must upgrade all ap-
pliances to version 9.1.0. The Enable New Stats Collection dialog box lists appliances that
must be upgraded to support the distributed stats collection.
3. Click Enable New Stats Collection Now.
WARNING: Do not discontinue legacy stats collection until you have collected sufficient his-
torical data with the Distributed Stats Collector feature. For example, if you need 30 days of
statistical data, enable the Distributed Stats Collector, wait 30 days, and then disable the legacy
stats collection.
To verify that data has been collected:
1. Navigate to Support > Technical Assistance > Partition Management.
2. Verify that the Stats Collector table contains sufficient data.
To discontinue legacy stats collection:
1. Navigate to Software & Setup > Setup > Stats Collector Configuration.
The Stats Collector Configuration tab opens.
2. Click Discontinue Legacy Stats Collection.
The Discontinue Legacy Stats Collection dialog box opens.
WARNING: This step permanently disables legacy Stats Collection and deletes all legacy
statistics.
3. Click Discontinue Legacy Stats Collection.
You can schedule a backup or use the CLI to back up Stats Collector on-demand.
• To schedule a backup of the Stats Collector, see Schedule Stats Collector Backup.
• To back up the Stats Collector with the CLI, log in to the CLI and run the following com-
mands:
cd /home/gms/sc
./sc_backup.sh
• If you are running Orchestrator release 9.1.9, 9.2.10, 9.3.3, 9.4.x, or later, enter sudo
su - gms
• If you are running an Orchestrator release earlier than those listed above, enter
su - gms to log in as gms user.
6. To confirm that the restore process completed successfully, open the /tmp/sc_restorelog
file and verify the “Restore successful!” message is listed.
7. Log out and log in as root user.
8. Enter service sc start
Notification Banner
Orchestrator > Software & Setup > Setup > Notification Banner
If you are conducting downtime or for maintenance reasons, you can add a notification in the
header of your Orchestrator UI. To add a notification, complete the following steps.
1. Navigate to Orchestrator > Software & Setup > Setup > Notification Banner in Or-
chestrator.
The Notification dialog box opens.
2. Enter the message you want to display in the Orchestrator header.
3. Click Save.
Prerequisites
Before you can integrate Unity EdgeConnect devices with HPE Aruba Networking Central, you
must do the following:
1. Create an HPE Aruba Networking Central account. For more information on creating an
HPE Aruba Networking Central account, see HPE Aruba Networking Central Online Help
and search for “Unity EdgeConnect Integration.”
2. Generate an API token for Orchestrator in HPE Aruba Networking Central. For more
information on generating an API token for Orchestrator, see HPE Aruba Networking
Central Online Help and search for “Unity EdgeConnect Integration.”
3. Have existing HPE Aruba Networking Central sites to map EdgeConnect appliances to.
If you do not have any existing HPE Aruba Networking Central sites, you can export the
location details for EdgeConnect appliances and create HPE Aruba Networking Central
sites in bulk from that exported list. For more information on creating HPE Aruba Net-
working Central sites in bulk, see Create HPE Aruba Networking Central Sites in Bulk.
You need the following details from your HPE Aruba Networking Central account.
Field Steps
Customer ID Navigate to Account Home, and then click the User icon in the
upper-right corner.
Email Navigate to Account Home > API Gateway > System Apps &
Tokens. The email is listed in the Name column.
Password Navigate to Account Home > API Gateway > System Apps &
Tokens, and then click View Tokens.
NOTE: If you do not remember the password, you must reset it from
HPE Aruba Networking Central. For more information on resetting
your HPE Aruba Networking Central password, see HPE Aruba
Networking Central Online Help.
Client ID Navigate to Accounts Home > API Gateway > APIs > System Apps
& Tokens.
Client Secret Navigate to Accounts Home > API Gateway > APIs > System Apps
& Tokens.
API Gateway Navigate to Account Home > API Gateway. The URL is listed in the
domain Documentation column.
1. In Orchestrator, navigate to Administration > Software > Upgrade > System Informa-
tion.
2. In the appliance tree, select the appliances you want to create HPE Aruba Networking
Central sites for, and then click Export.
Orchestrator creates and downloads a .csv file.
3. Open the .csv file, and then delete the three header rows.
TIP: Refer to the sample import file provided by HPE Aruba Networking Central for proper
formatting. To view the sample import file, in HPE Aruba Networking Central, navigate to
Launch > Network Operations > Organization > Sites > Bulk Upload, and then click
Download a sample file on the Bulk Import dialog.
4. Save and close the file.
5. In HPE Aruba Networking Central, navigate to Launch > Network Operations > Orga-
nization > Sites.
6. Scroll to the bottom of the page, click Bulk Upload, and then follow the prompts.
1. On the HPE ANW Central Site Mapping tab, click HPE ANW Central Account.
The HPE ANW Central Account dialog box opens.
2. Configure the following elements as needed:
Field Description
NOTE: If you do not remember the password you must reset the
HPE Aruba Networking Central password from HPE Aruba
Networking Central. For more information on resetting your HPE
Aruba Networking Central password, see HPE Aruba Networking
Central Online Help.
Client ID Client ID generated from HPE Aruba Networking Central.
Client Secret Client Secret generated from HPE Aruba Networking Central.
API Gateway API Gateway URL without protocol (for example,
domain internal-apigw.central.arubanetworks.com).
3. (Optional) To test the connection, click Test. To save without testing, see the IMPORTANT
notice below, and then skip to step 4.
IMPORTANT: Because of how HPE Aruba Networking Central processes account infor-
mation, if you click Test or Save, you must wait 30 minutes before you click Test or Save
again. If you click Test or Save a second time before 30 minutes have past, you will re-
ceive an error that the connection failed even if you successfully connected to HPE Aruba
Networking Central. To resolve this issue, wait 30 minutes before clicking Test or Save
again.
4. To save the connection, click Save.
Orchestrator maps EdgeConnect appliances to HPE Aruba Networking Central sites
based on geolocation. (Addresses assigned to EdgeConnect appliances are converted
to geolocations.)
5. If “None” displays in the HPE Aruba Networking Central Site column of an appliance,
Orchestrator did not locate an HPE Aruba Networking Central site within range of the
appliance (within 0.2 degrees of the latitudeDelta and the longitudeDelta combined). Do
one of the following:
• Edit the appliance and manually map it to any HPE Aruba Networking Central site.
For more information on mapping an EdgeConnect appliance to an HPE Aruba Net-
working Central site, see Edit EdgeConnect to HPE Aruba Networking Central Site
Mapping.
• Add an HPE Aruba Networking Central Site within range of the EdgeConnect appli-
ance, and then check for site list updates. For more information on checking for site
list updates, see Check for Site List Updates.
Field Description
3. Click Save.
Orchestrator maps the appliance to the HPE Aruba Networking Central site you selected.
• To determine which actions you want to display in the table, select the All, Active, or
Historical filters.
• To refresh or pause the table, select Auto Refresh or Pause. By default, the table re-
freshes automatically.
• To limit the filtering criteria, enter a value in the Record Count field. The default value is
500, and the maximum value is 10,000.
• To filter by date and time, enter values in the From and To fields.
• To search for a specific username, enter a value in the User field. You can search a wild
card character (*) as a username using the following schema:
Field Definition
Start Time Time when the device began its network session.
End Time Time when the device ended its network session.
CPPM ClearPass Policy Manager server used to authenticate.
IP Address IP address authenticated to the network.
Field Definition
The ClearPass Policy Manager Accounts dialog box displays the following information about
ClearPass accounts that are already associated with Orchestrator:
Field Definition
Follow the steps below to add a new ClearPass Policy Manager account.
1. If not already opened, click Accounts to open the ClearPass Policy Manager Accounts
dialog box.
2. Click +Add New Server.
The ClearPass Policy Manager Server Configuration dialog box opens.
3. Enter the following information:
Field Definition
4. Click Save.
Your CPPM instance now appears in the ClearPass Policy Manager Accounts dialog box. The
Connectivity and Service Status fields should both appear as Connected.
1. If not already opened, click Accounts to open the ClearPass Policy Manager Accounts
dialog box.
2. Click the Edit icon next to the instance you want to edit.
The ClearPass Policy Manager Server Configuration dialog box opens.
3. Edit the information in the dialog box, and then click Save.
Prerequisites
The following prerequisites are required to deploy the Unified Fabric solution.
1. Navigate to Orchestrator > HPE Integration Services > HPE Aruba Networking Cen-
tral.
The Enable HPE Aruba Networking Central dialog box opens.
2. Click Enable HPE Aruba Networking Central, and then click Save.
3. Follow the steps in Unified Fabric Deployment Guide to complete the Unified Fabric in-
tegration.
Support
The menus under Support provide troubleshooting tools and different options for working
with Support, including opening a support case. You can use these menus to gather informa-
tion to help Support troubleshoot issues. These menus are organized as follows:
• Technical Assistance
• User Documentation
• Reporting
Field Description
Download to Orchestrator
Complete the following steps if you want to download one or more files to Orchestrator.
1. Select one or more files in the table (use Ctrl or Shift to select multiple files).
2. Click the Download to Orchestrator button above the table.
3. When prompted, click Download to confirm or click Close to cancel.
The Monitor Transfer Progress window appears, showing the status of current and pre-
vious downloads.
4. To stop any downloads that are not yet finished, click Cancel.
NOTE: To access any files that have been downloaded, open the Tech Support - Orches-
trator tab under the Support menu. After selecting one or more files, you can create a
new case, upload files to an existing case, or download files to your local machine.
Field Description
You can also access this page by navigating to Silver Peak’s web page and selecting Support >
Customer Login from the menu bar.
Packet Capture
Support > Technical Assistance > Packet Capture
When requested by Support, use this tab to capture packets for appliances that are selected
in the appliance tree.
The following table describes each field on this tab.
Field Description
Field Description
Bytes to capture Enter the number of bytes (the amount of data) for each frame to
from each capture. For example, enter 96 to capture headers only or 1500 to
packet (snap capture full frames.
length)
NOTE: Configuring a large snap length will result in larger packet
capture file sizes.
Additional filter Enter other options to filter the capture. For example,
options proto 17 src 1.1.1.1
Enable circular Select this check box to limit the amount of data to store by setting a
storage maximum number of files and maximum file size for the capture. For
example, set the Number of files to 5 and Max size per file to 100 (MB).
Once the size limit is reached for a file, a new file will be written. Once
the maximum number of files is reached, the oldest file will be
overwritten.
Number of files If you enabled circular storage, enter the maximum number of files that
can be stored for this packet capture.
Max size per file If you enabled circular storage, enter the maximum file size that can be
stored for this packet capture.
Command Displays the progress of the packet capture.
preview
Partition Management
Support > Technical Assistance > Partition Management
Use this tab to regain Orchestrator disk space by selectively eliminating statistics no longer
needed.
Field Description
Enable Receiver Click this slider to toggle between enabled and disabled state.
Name Name of the receiver the logs are going to.
Log Type Select the type of log from the list you want to apply.
URL URL served by HTTP/HTTPS log server that Orchestrator will send log
data with POST REST calls.
User Name User name used in Basic Authentication when making REST calls
(Optional).
Password Password used in Basic Authentication when making REST calls.
(Optional).
Repeat Password Your password repeated.
Field Description
Enable Receiver Click this slider to toggle between enabled and disabled state.
Name Name of the receiver the logs are going to.
Log Type Select the type of log from the list you want to apply.
URL URL of the HTTPS Receiver.
User Name User name used in Basic Authentication when making REST calls
(Optional).
Password Password used in Basic Authentication when making REST calls
(Optional).
Repeat Password Your password repeated.
Field Description
Enable Receiver Click this slider to toggle between enabled and disabled state.
Name Name of the receiver the logs are going to.
Log Type Select the type of log from the list you want to apply.
Topic Topic name on KAFKA Receiver.
Bootstrap Servers Domain name served by KAFKA Receiver. For example,
“xxx.com:9092”, “1.1.1.1:9092”.
Field Description
Field Description
Enable Receiver Click this slider to toggle between enabled and disabled state.
General Settings
Field Description
Facility Settings
Field Description
Field Description
Error Severity level of the error; select from the drop-down menu.
Info Severity level of the information; select from the drop-down menu.
Debug Severity level of the debug; select from the drop-down menu.
Provides a reliable streaming mechanism for alarms and Orchestrator audit logs across all
appliances. It is initiated from the client side and sent to Orchestrator for authentication.
When authenticated by Orchestrator, asynchronous notifications are sent in JSON objects.
Field Description
Enable Click this slider to toggle between enabled and disabled state.
Name Name of the WebSocket receiver.
Log Type Type of log being sent to the WebSocket receiver.
IP Allow List List of source IP addresses that are allowed WebSocket access to
Orchestrator.
You need the following items to establish connectivity from Orchestrator to the WebSocket
receiver:
JSON Format
For HTTP, HTTPS, KAFKA, and WEBSOCKET servers, remote log messages are sent using REST
POST requests, and the messages are sent in JSON format.
There are two JSON message formats, one for alarm messages and one for audit log messages.
The following tables describe the data found in each type of JSON message.
JSON Alarm Message Format
Note: See JSON Data Key for Orchestrator and Appliance Alarms for
detailed information about the data fields that appear in the data key.
message string A pipe delimited message that provides brief details about the event.
Note: See JSON Data Key for Audit Logs for detailed information
about the data fields that appear in the data key.
message string A pipe delimited message that provides brief details about the event.
The following tables describe the detailed information contained in the data key for each type
of JSON message. The data key contains the bulk of the message data and has detailed infor-
mation about the alarm or the audit log.
JSON Data Key for Orchestrator and Appliance Alarms
structured RFC5424 This field contains the sequenceId and detailed alarm or audit log
data data. Data wrapped in brackets [. . . ], can have one or more
structured data elements.
Structured Data
Each syslog message contains two structured data elements. The first element contains infor-
mation about the alarm or audit log, and there are three formats for the first element; one
for Orchestrator alarm messages, one for appliance alarm messages, and one for audit log
messages. The second structured data element contains the metadata. The following tables
describe the information contained in the structured data elements.
RFC5424 Structured Data Element for Orchestrator Alarms
For an Orchestrator alarm, the first structured data element in the syslog message contains
detailed Orchestrator alarm information.
raisedTime epoch The time in UTC at which the alarm was raised.
milliseconds
clearedTime epoch The time in UTC at which the alarm was cleared by the
milliseconds user. A value of “0” indicates the alarm is still active.
description string A description of the alarm.
recommendedActionstring Recommended actions the user can take to clear the
alarm.
closed boolean Indicates if the alarm has been cleared.
For audit logs, the first structured data element in the syslog message contains detailed audit
log information.
You can use the Routing Peer Table tab to track the communication between multiple peers
within a network and for troubleshooting purposes. This tab also reflects the details of the
subnet information being shared between each set of peers.
The following table describes the fields on the Routing Peer Table tab.
Field Description
RMA Wizard
Support > Technical Assistance > RMA
The RMA (Return Merchandise Authorization) Wizard automates the RMA process for an ex-
change or replacement of your appliance, if needed. It includes appliance discovery, the ver-
sion of the appliance, and a backup selection. Use this screen as instructed by Support to
prepare an RMA.
• Upgrade or downgrade the new appliance to the same software version before shipping
to the site. This will save time.
• Perform a backup of the Orchestrator and EdgeConnect appliances.
• Install the new EdgeConnect appliance onsite.
• When Orchestrator discovers the new device, do not approve it. Start the RMA process
to move the license to the new EdgeConnect appliance.
If the software version you selected for your backup appliance is lower than that of the dis-
covered appliance, you will need to do the following:
Alarm Descriptions
Support > User Documentation > Alarm Descriptions
Orchestrator enables you to export to a CSV file a full list of alarms you could potentially re-
ceive. To automatically export the CSV file, navigate to Support > User Documentation >
Alarm Descriptions.
The CSV file includes the following information:
– Critical: Critical alarms are service-affecting and require immediate attention. They
reflect conditions that adversely affect an appliance or indicate the loss of a broad
category of service.
– Major: While service-affecting, major alarms are less severe than critical alarms.
They reflect conditions that should be addressed in the next 24 hours. An example
would be an alarm caused by an unexpected traffic class error.
– Minor: Minor alarms are not service-affecting and can be addressed at any time.
Examples include alarms caused by a user who has not changed their account’s
default password, a degraded disk, or a software version mismatch.
– Warning: Warning alarms are not service-affecting. They warn of conditions that
could become problems over time—for example, an alarm caused by IP SLA being
down.
– 0: EdgeConnect appliance
– 100: Orchestrator
– 200: Orchestrator-SP or Orchestrator Global Enterprise
• Alarm Type: Indicates an index into the specific alarm category. For example,
within the Tunnel alarm category, there is an alarm type associated with in-
dex 0 (INTERFACES_WITH_DUPLICATE_IP_EXIST), another with index 1 (INTER-
FACES_WITH_NO_PUBLIC_IP_EXIST), and so forth. Each alarm type within an alarm
category has a unique ID.
• Clearable: Indicates whether you can clear the alarm.
Built-in Policies
Support > User Documentation > Built-in Policies
This table displays read-only built-in policies, which are executed before any other policies.
Realtime Charts
Support > Reporting > Realtime Charts
As an aid to troubleshooting, Realtime Charts are useful for monitoring the performance of
individual appliances. You can save sets of charts as dashboards.
Historical Charts
Support > Reporting > Historical Charts
As an aid to troubleshooting, Historical Charts are useful for reviewing the performance of
individual appliances. You can save sets of charts as dashboards.
Appliance Charts
Support > Reporting > Appliance Charts
Use this dialog box to access an individual appliance’s realtime and historical charts.
You can customize the chart settings using the controls at the top of the tab, as follows:
Option Description
Time period Click Real Time to enable live statistics for all available
interfaces.
Option Description
Show in UTC Click this option to toggle chart times between local
appliance time or UTC.
Large Click this option to toggle the size of the charts between
smaller (default) and large.
Lock Scale By default, each chart uses its own scale that is relative
to the data displayed. Click this option to apply and lock
the same scale to each chart.
Refresh Click the Refresh button to fetch data again for the
selected time period.
Granularity When a custom time period is used, select the
granularity level to be applied to charts (Minute, Hour,
or Day).
System Performance
Support > Reporting > System Performance
This tab shows Orchestrator metrics.
Orchestrators located in the cloud cannot display useful information about host memory, file
descriptors, sockets, or pipes.
Field Description
Orchestrator Debug
Support > Reporting > Orchestrator Debug
This dialog box provides the various debugging tools available to Support for troubleshooting
and debugging issues with Orchestrator.
Field Description
Field Description
Unverified Emails
Support > Reporting > Unverified Emails
When you add an email address to either the Alarms or the Reports email distribution list,
Orchestrator sends the recipient an email that contains a link, asking them to click to provide
verification.
If Orchestrator does not receive a verification, either the recipient has not responded or the
email address is invalid.
• An unverified email address remains inactive and does not generate an alarm.
• You can retest an address with Resend.
• You can only correct an email address in the Alarm or Reports email distribution list.
• You have the option to apply keywords to filter the logs. Keyword filtering only takes
place in the Orchestrator interface and the filters are not sent back to the server. To do
this, enter a keyword in the Keyword Filter field and click Enter. If you apply multiple
keyword filters, the filters are applied using a logical OR operator.
• You can select the log level from the drop-down menu. Only logs from that level and
above are included. The system defaults to the Info log level, which includes Info, Warn,
Error, and Fatal logs.
• To run the live tail logger utility, click Run. To pause the utility click Pause, and to resume
the utility click Run.
• To clear all logs from the Live Tail Logger tab, click Clear.
• To export the logs displayed on the Live Tail Logger tab, click Export Terminal. The logs
are exported in a .log file.
• The maximum number of lines that you can scroll back through on the Live Tail Logger
tab is 10,000. To configure this setting, navigate to Orchestrator > Software & Setup >
Setup > Advanced Properties and change the value for maxLiveTailLoggerTerminalLi-
nesScrollBack.
NOTE: Changing this default is not recommended without consulting HPE Aruba Net-
working.