Supported Target Versions |
---|
Silverpeak orchestrator version 9.1.3.40229 |
ECOS appliance release 9.1.1.4_91861 |
Application Version and Upgrade Details
Application Version | Bug fixes / Enhancements |
---|---|
3.0.0 | Added support for get latest metrics, custom macros, API statistics metric and cache flush changes |
2.0.0 | Since there are no metrics on disk resources, removed disks from discovery. Additionally, discovery and monitoring support for tunnels have also been removed. |
1.0.0 | Supported the SilverPeak SD-WAN application. The resources that can be discovered in version 1.0.0 include SilverPeak Orchestrator, appliances, tunnels, disks, and interfaces. |
Introduction
A software-defined wide area network (SD-WAN) is a more intelligent, cloud-first way to build a WAN. It improves business productivity and end-user quality of experience, accelerates business initiatives, and lowers costs. As applications continue to migrate to the cloud, enterprises are realizing that an SD-WAN is a better way to accelerate business initiatives and enable digital transformation.
Silverpeak orchestrator enables you to globally monitor performance and manage EdgeConnect (EC) appliances, whether you are configuring a WAN Optimization network (NX, VX, or VRX appliances) or an SD-WAN network (EC or EC-V appliances).
Prerequisites
- OpsRamp Classic Gateway 14.0.0 and above.
- OpsRamp NextGen Gateway 14.0.0 and above.
Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.
Default Monitoring Configurations
Silverpeak SDWAN application has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. OpsRamp recommends performing the below activity before installing the application to avoid noise alerts and data.
Default Global Device Management Policies
OpsRamp has a Global Device Management Policy for each Native Type of Silverpeak SDWAN. You can find these Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:
{appName nativeType - version}
Ex: silverpeak-sdwan Silverpeak Orchestrator - 1 (i.e, appName = silverpeak-sdwan, nativeType = Silverpeak Orchestrator version = 1)
Default Global Templates
OpsRamp has a Global Template for each Native Type of Silverpeak SDWAN. You can find these templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:
{appName nativeType 'Template' - version}
Ex: silverpeak-sdwan Silverpeak Orchestrator Template - 1 (i.e, appName = silverpeak-sdwan, nativeType = Silverpeak Orchestrator, version = 1)
Default Global Monitors
OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find these monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:
{monitorKey appName nativeType - version}
Ex: Silverpeak Orchestrator Monitor silverpeak-sdwan Silverpeak Orchestrator 1 (i.e, monitorKey = Silverpeak Orchestrator Monitor, appName = silverpeak-sdwan, nativeType = Silverpeak Orchestrator, version = 1)
Hierarchy of Silverpeak SD WAN
Silverpeak Orchestrator
- Silverpeak Appliance
- Silverpeak ECOS Interface
- Silverpeak ECOS Disk
Configure and Install the Silverpeak SDWAN Integration
- From All Clients, select a client.
- Go to Setup > Integrations and Apps.
- The INSTALLED INTEGRATIONS page, where all the installed applications are displayed.
Note: If there are no installed applications, it will navigate to the ADD APP page.

- Click + ADD on the INSTALLED INTEGRATIONS page. The AVAILABLE INTEGRATIONS AND APPS page displays all the available applications along with the newly created application with the version.
Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.

- Click ADD in the Silverpeak SDWAN application.
- In the Configurations page, click + ADD. The Add Configuration page appears.
- Enter the below mentioned BASIC INFORMATION:
Funtionality | Description |
---|---|
Name | Enter the name for the configuration |
IP Address/Host Name | IP address/host name of the target. |
Port | Port. Example: By default 443 is selected. |
Credential | Select the credentials from the drop-down list. Note: Click + Add to create a credential. |
Notes:
- By default the Is Secure checkbox is selected.
- Ip Address/Host Name and Port should be accessible from Gateway.
- App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
- Select the below mentioned Custom Attribute:
Functionality | Description |
---|---|
Custom Attribute | Select the custom attribute from the drop down list box. |
Value | Select the value from the drop down list box. |
Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).
- In the RESOURCE TYPE section, select:
- ALL: All the existing and future resources will be discovered.
- SELECT: You can select one or multiple resources to be discovered.
- In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
- Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
- Click NEXT.
- Below are the optional steps you can perform on the Installation page.
Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

- Click +ADD to create a new collector by providing a name or use the pre-populated name.

- Select an existing registered profile.

- Click FINISH.
The integration is now installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed application.
Modify the Configuration
See Modify an Installed Integration or Application article.
Note: Select the Silverpeak SDWAN application.
View the Silverpeak SDWAN details
The discovered resource(s) are displayed in Infrastructure > Resources > Silverpeak SDWAN. You can navigate to the Attributes tab to view the discovery details, and Metrics tab to view the metric details for Silverpeak SDWAN.


Resource Type Filter Keys
Click here to view the Supported Input Keys
Resource Type | Resource Type |
---|---|
All Types | resourceName |
hostName | |
aliasName | |
dnsName | |
ipAddress | |
macAddress | |
os | |
make | |
model | |
serialNumber | |
Silverpeak Orchestrator | Version |
Platform | |
Silverpeak Appliance | Appliance Id |
Group Id | |
Mode | |
Platform | |
Hardware Revision | |
Software Version | |
Silverpeak ECOS Interface | Appliance NEPK |
Admin | |
IPV4 Mask | |
IPV4 Dhcp | |
Index | |
MTU |
Supported Alert Custom Macros
Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:
Click here to view the alert subject and description with macros
${resource.name}
${resource.ip}
${resource.mac}
${resource.aliasname}
${resource.os}
${resource.type}
${resource.dnsname}
${resource.alternateip}
${resource.make}
${resource.model}
${resource.serialnumber}
${resource.systemId}
${parent.resource.name}
${Custom attributes on the resource}
Supported Metrics
Click here to view the supported metrics
Native Type | Metric Name | Metric Display Name | Units | Application Version | Description |
---|---|---|---|---|---|
Silverpeak Orchestrator | silverpeak_orchestartor_APIStatistics | Silverpeak Orchestrator APIStatistics | 3.0.0 | Returns number of API calls made to the target device for each poll for all the resources | |
silverpeak_orchestrator_UpTime | Silverpeak Orchestrator UpTime | m | 1.0.0 | Silverpeak Orchestrator Uptime | |
silverpeak_orchestrator_ActiveUsers | Silverpeak Orchestrator Active Users | count | 1.0.0 | Silverpeak Orchestrator Active Users | |
silverpeak_orchestrator_BuffersMemory | Silverpeak Orchestrator Buffer Memory | MB | 1.0.0 | Silverpeak Orchestrator Buffer Memory | |
silverpeak_orchestrator_UsedMemory | Silverpeak Orchestrator Memory Usage | GB | 1.0.0 | Silverpeak Orchestrator Memory Usage | |
silverpeak_orchestrator_TotalMemory | Silverpeak Orchestrator Total Memory | GB | 1.0.0 | Silverpeak Orchestrator Total Memory | |
silverpeak_orchestrator_FreeMemory | Silverpeak Orchestrator Free Memory | GB | 1.0.0 | Silverpeak Orchestrator Free Memory | |
silverpeak_orchestrator_MemoryUtilization | Silverpeak Orchestrator Memory Utilization | % | 1.0.0 | Silverpeak Orchestrator Memory Utilization | |
silverpeak_orchestrator_ApplianceCount | Silverpeak Orchestrator Appliance Count | count | 1.0.0 | Silverpeak Orchestrator Appliance Count | |
silverpeak_orchestrator_UsedSwapMemory | Silverpeak Orchestrator Swap Memory Usage | KB | 1.0.0 | Silverpeak Orchestrator Swap Memory Usage | |
silverpeak_orchestrator_FreeSwapMemory | Silverpeak Orchestrator Free Swap Memory | KB | 1.0.0 | Silverpeak Orchestrator Free Swap Memory | |
silverpeak_orchestrator_TotalSwapMemory | Silverpeak Orchestrator Total Swap Memory | KB | 1.0.0 | Silverpeak Orchestrator Total Swap Memory | |
silverpeak_orchestrator_SwapMemoryUtilization | Silverpeak Orchestrator Swap Memory Utilization | % | 1.0.0 | Silverpeak Orchestrator Swap Memory Utilization | |
silverpeak_orchestrator_TotalHeapMemory | Silverpeak Orchestrator Total Heap Memory | GB | 1.0.0 | Silverpeak Orchestrator Total Heap Memory | |
silverpeak_orchestrator_UsedHeapMemory | Silverpeak Orchestrator Heap Memory Usage | GB | 1.0.0 | Silverpeak Orchestrator Heap Memory Usage | |
silverpeak_orchestrator_CachedSwapMemory | Silverpeak Orchestrator Cached Swap Memory | GB | 1.0.0 | Silverpeak Orchestrator Cached Swap Memory | |
Silverpeak Appliance | silverpeak_appliance_UpTime | Silverpeak Appliance Uptime | m | 1.0.0 | Silverpeak Appliance Uptime |
silverpeak_appliance_license_DaystoExpiry | Silverpeak Appliance License Days to Expiry | Days | 1.0.0 | Silverpeak Appliance License Days to Expiry | |
silverpeak_appliance_CpuUtilization | Silverpeak Appliance CPU Utilization | % | 1.0.0 | Silverpeak Appliance CPU Utilization | |
silverpeak_appliance_TotalMemory | Silverpeak Appliance Total Memory | GB | 1.0.0 | Silverpeak Appliance Total Memory | |
silverpeak_appliance_FreeMemory | Silverpeak Appliance Free Memory | GB | 1.0.0 | Silverpeak Appliance Free Memory | |
silverpeak_appliance_UsedMemory | Silverpeak Appliance Memory Usage | GB | 1.0.0 | Silverpeak Appliance Memory Usage | |
silverpeak_appliance_MemoryUtilization | Silverpeak Appliance Memory Utilization | % | 1.0.0 | Silverpeak Appliance Memory Utilization | |
silverpeak_appliance_TotalBuffers | Silverpeak Appliance Total Buffer Memory | MB | 1.0.0 | Silverpeak Appliance Total Buffer Memory | |
silverpeak_appliance_CachedMemory | Silverpeak Appliance Cached Memory | GB | 1.0.0 | Silverpeak Appliance Cached Memory | |
silverpeak_appliance_TotalSwapMemory | Silverpeak Appliance Total Swap Memory | KB | 1.0.0 | Silverpeak Appliance Total Swap Memory | |
silverpeak_appliance_FreeSwapMemory | Silverpeak Appliance Free Swap Memory | KB | 1.0.0 | Silverpeak Appliance Free Swap Memory | |
silverpeak_appliance_UsedSwapMemory | Silverpeak Appliance Swap Memory Usage | KB | 1.0.0 | Silverpeak Appliance Swap Memory Usage | |
silverpeak_appliance_SwapMemoryutilization | Silverpeak Appliance Swap Memory Utilization | % | 1.0.0 | Silverpeak Appliance Swap Memory Utilization | |
silverpeak_appliance_processstate_VmPeak | Silverpeak Appliance Process state VmPeak | GB | 1.0.0 | Silverpeak Appliance Process state VmPeak | |
silverpeak_appliance_processstate_VmSize | Silverpeak Appliance Process state VmSize | GB | 1.0.0 | Silverpeak Appliance Process state VmSize | |
silverpeak_appliance_processstate_VmRSS | Silverpeak Appliance Process state VmRSS | MB | 1.0.0 | Silverpeak Appliance Process state VmRSS | |
Silverpeak ECOS Interface | silverpeak_ecos_interface_Status | Silverpeak ECOS Interface Status | 1.0.0 | Silverpeak ECOS Interface Status. Possible values are: up : 0 , down : 1 | |
silverpeak_ecos_interface_InTraffic | Silverpeak ECOS Interface In Traffic | Bytes per second | 1.0.0 | Silverpeak ECOS interface traffic in rate | |
silverpeak_ecos_interface_OutTraffic | Silverpeak ECOS Interface Out Traffic | Bytes per second | 1.0.0 | Silverpeak ECOS interface traffic out rate | |
silverpeak_ecos_interface_InPackets | Silverpeak ECOS Interface In Packets | packets/sec | 1.0.0 | Silverpeak ECOS interface packets in rate | |
silverpeak_ecos_interface_OutPackets | Silverpeak ECOS Interface Out Packets | packets/sec | 1.0.0 | Silverpeak ECOS interface packets out rate | |
silverpeak_ecos_interface_InErrors | Silverpeak ECOS Interface In Errors | Errors / sec | 1.0.0 | Silverpeak ECOS Interface in errors | |
silverpeak_ecos_interface_OutErrors | Silverpeak ECOS Interface Out Errors | Errors / sec | 1.0.0 | Silverpeak ECOS interface out errors | |
silverpeak_ecos_interface_InDiscards | Silverpeak ECOS Interface In Discards | psec | 1.0.0 | Silverpeak ECOS interface in discards | |
silverpeak_ecos_interface_OutDiscards | Silverpeak ECOS Interface Out Discards | psec | 1.0.0 | Silverpeak ECOS interface out discards |
Risks and Limitations
- Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
- Connectivity Exception
- Authentication Exception
- Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
- Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
- Application cannot control monitoring pause/resume actions based on above alerts.
- Macro replacement limitation (i.e, customization of threshold breach alert subject, description).
- This application supports both Classic Gateway and NextGen Gateway.
- Not supported with Cluster Gateway.
- No support of showing applied time on templates.