SevOne logo
You must be logged into the NMS to search.

Table of Contents (Start)

Integrate SevOne NMS With Other Applications

This documentation applies to NMS version 5.4. An online version of the software can be found here.

SevOne NMS event management simplifies enterprise integration and enables network managers to configure and create customized alert policies and thresholds that can be sent as traps to an enterprise fault management system or viewed natively through the SevOne NMS Web-based GUI.

SevOne integration ensures that your network management components work in sync to achieve automation, leverage existing tools, and provide a single pane of glass. Integration points include (but are not limited to) topology synchronization, performance alert forwarding, map click, and forwarding. SevOne NMS seamlessly integrates with other network management solutions including EMC SMARTS, HP OpenView, and Spectrum.

SevOne API

SevOne NMS provides a full featured, comprehensive API which makes it easy to integrate with other products as well as to create portals, extract or even import information in SevOne NMS. The API is Web services compliant (SOAP) and for use from virtually any development environment including PHP, Java, ASP, and C++.

To access API documentation and examples enter the following URL:

http://<IP_address_of_appliance>/soap3/docs/

forcelogin Script

SevOne NMS provides the ability to create URLs that enable you to integrate SevOne NMS with third party applications. You can customize the URL to automatically authenticate a user, navigate directly to a specific page, and include the interface parameters to perform various actions.

You can use a script called forcelogin to create the URLs that redirect a user to a particular SevOne NMS page. This URL authenticates a user and handles the internal navigation logic to redirect you to the page you specify.

The forcelogin script is located at: http://<IP_address_of_appliance>/forcelogin.php

The forcelogin script uses a URL you construct with a combination of the following parameters.

  • username - A valid SevOne NMS user name (required).

  • password - The password for the valid user (required).

  • domino - The page to which navigate the user (required).

  • params - The page specific parameters to define interface interactions and information display (optional).

Access Alerts Page Example: The following is a URL that logs jsmith with password sm!tty onto SevOne NMS to the Alerts page.

http://[IP_OF_APPLIANCE]/forcelogin.php?username=jsmith&password=sm!tty&domino=Alerts

You can add additional parameters to the URL to display reports, display the Device Summary for a specific device, or to filter the list of results on the page.

Alerts Page Grouping Example: The following URL expands on the previous example to change the default grouping setting from Alerts to Device Group.

http://[IP_OF_APPLIANCE]/forcelogin.php?username=jsmith&password=sm!tty&domino=Alerts&params[groupingType]=2

Supported Pages

You can use the forcelogin script to navigate to any page. The following parameters for the following pages are tested and updated for this version of SevOne NMS.

Alerts

Domino - Alerts

Parameters

  • msg - Alert Message

  • deviceGroups - Device Groups. This must be an array.

  • devices - Devices. This can be a string (digits only) or an array.

  • endTime - End Time

  • groupingType - Grouping Type

    • 0 - Alert

    • 1 - Device

    • 2 - Device Group

    • 3 - Object Group

  • objectGroups - Object Groups. This must be an array.

  • refreshRate - Refresh Rate

    • 0 - Off

    • 5000 - 5 seconds

    • 10000 - 10 seconds

    • 15000 - 5 seconds

    • 30000 - 30 seconds (default)

    • 60000 - 1 minute

    • 120000 - 2 minutes

    • 300000 - 5 minutes

    • 600000 - 10 minutes

    • 1800000 - 30 minutes

  • severities - Alert Severities (default [ 0, 1, 2, 3, 4, 5, 6, 7 ] ). Can be a single parameter or an array.

  • showFilter - Show Filters

    • 0 - Do not expand the Filter section.

    • 1 - Expand the Filter section.

  • showIgnored - Show Ignored Alerts

    • 0 - Active Only alerts.

    • 1 - Both ( both Active and ignored Alerts).

  • isClosed - Whether or not to display closed alerts (Alert Archives) or open alerts.

    • 0 - Display open alerts (default)

    • 1 - Display closed alerts.

  • orderBy - Order By (default - [ severity: ASC, endTime: DESC, name: ASC ]). This must be an associative array.

  • startTime - Start Time

Alerts Page Device Groups Example: Http://<test_appliance>/forcelogin.php?username=admin&password=SevOne&domino=alerts&params[deviceGroups][]=17&params[deviceGroups][]=13params[deviceGroups] Note: [ ] indicates that deviceGroups is an array.

Alerts Page Severities Examples: http://<test_appliance>/forcelogin.php?username=admin&password=SevOne&domino=alerts&params[severities][]=17&params[severities][]=13 Note: This form is necessary to pass multiple severities.http://<test_appliance>/forcelogin.php?username=admin&password=SevOne&domino=alerts&params[severities]=1 Note: You can leave out the empty bracket for a single severity.

Alerts Page Order By Example: (The orderBy param must be an array)

http://<test_appliance>/forcelogin.php?username=admin&password=SevOne&domino=alerts&params[orderBy][severity]=DESC&params[orderBy][name]=ASC

Custom Dashboard

Domino - DashboardReports

Parameters

  • reportId - Report ID. Get the report ID from the Report Manager. When you view a report the report ID appears in the URL address field.

  • reportName - Report Name

Instant Graphs

Domino - InstantGraphs

Parameters

none available

Device Summary or Object Summary

Domino -DeviceReport or ObjectStatus

Parameters

Note: the "t" in front of the parameter is required and each parameter is an array not a single value.

  • tDeviceIds - The ID of the device for which to get the status. Get device IDs from the Device Manager when you select to display the ID column.

  • tDeviceNames - The name of the device for which to get the status, when the ID is unavailable.

  • tDeviceIps - The IP address of the device for which to get the status, when the ID and the name are unavailable.

  • tDeviceGroupIds

  • tDeviceGroupNames

  • tObjIds

  • tObjectGroupIds

  • tObjectGroupNames

Example: The following is a URL to run a report with ID 33 on the Core Switch (ID 68).

http://<your SevOne IP>/forcelogin.php?username=admin&password=password&do mino=viewreport&params[tDeviceIds][]=68&params[reportId]=33

Welcome Dashboard

Domino - Dashboard

Parameters

none available

Unsupported Pages

The following is the list of dominoes for all other SevOne NMS UIs. Savvy users can use these dominoes to create URLs for the forcelogin script that access other SevOne NMS pages.

  • Page Name - Domino

  • About - about

  • Alert Summary - AlertSummary

  • Alert Archive - AlertArchive

  • Authentication Settings - AuthenticationSettings

  • Baseline Rule Manager - BaselineManager

  • Calculation Editor - CalculationEditor

  • Cluster Manager - ClusterManager

  • Device Groups - DeviceGroupEditor

  • Device Manager - DeviceManager

  • Device Mover - DeviceMover

  • Device Types - DeviceTypes

  • Discovery Manager - DiscoveryManager

  • Edit Device - DeviceEditor

  • FlowFalcon Reports - FlowFalconReports

  • Flow Interface Manager - FlowInterfaceManager

  • Flow Template Status - FlowTemplateStatus

  • FlowFalcon View Editor - FlowFalconViewEditor

  • High Frequency Poller - HighFrequencyPoller

  • Indicator Type Map - IndicatorTypeMap

  • Instant Status - InstantStatus

  • Login - login

  • Logged Traps - LoggedTraps

  • MIB Manager - MIBManager

  • MPLS Flow Mapping - MPLSFlowMapping

  • My Preferences - MyPreferences

  • NBAR Reports - NBARReports

  • Network Segment Manager - NetworkSegmentManager

  • New Device - DeviceCreator

  • Object Groups - ObjectGroups

  • Object Manager - ObjectManager

  • Object Mapping - FlowObjectMapping

  • Object Rules - PluginsObjectRules

  • Object Subtype Manager - ObjectSubTypeManager

  • Policy Browser - PolicyBrowser

  • Policy Editor - PolicyEditor

  • Probe Manager - ProbeManager

  • Protocols and Services - ProtocolsAndServices

  • Report Attachment Wizard - doms/wizard/index.php

  • Report Manager - ReportManager

  • SNMP OID Browser - SNMPOIDBrowser

  • SNMP Walk - SnmpWalk

  • Startup Wizard - StartupWizard

  • Status Map Editor - MapEditor

  • Status Map Manager - StatusMapManager

  • Status Map Viewer - MapViewer

  • Telephony Browser - TelephonyBrowser

  • Telephony Reports - TelephonyReports

  • Threshold Browser - ThresholdBrowser

  • Threshold Editor - ThresholdEditor

  • TopN Reports - TopNReports

  • Trap Destination Associations - TrapDestinationAssociations

  • Trap Destinations - TrapDestinations

  • Trap Event Editor - TrapEventEditor

  • Unknown Traps - UnknownTraps

  • User Role Manager - UserRoleManager

  • User Manager - UserManager

  • VMware Browser - VMWareBrowser

  • Work Hours - WorkHours

  • xStats Log Viewer - XStatsLogViewer

  • xStats Source Manager - XStatsSourceManager

Created with Scroll Wiki HTML Exporter for Confluence.