IP SLA Quick Start Guide

SNMP Plugin

Perform the following steps to configure the SNMP plugin for a device. For detailed information about SNMP, see our documentation on the topic.

1. From the navigation bar, click Devices and select Device Manager.
   

2. Locate the device that you would like to enable the IP SLA plugin on and click to display the Edit Device page.
   

3. The plugin section appears in the lower half of the Edit Device page. It should be set to SNMP by default. If not, click the drop-down and select SNMP.

4. If the the SNMP Capable check box is not already selected, select it to enable the discovery of SNMP data.

5. Click the Version drop-down and select an SNMP version.

6. Select the Lock Version check box to use the SNMP version that you specified in the previous step.

7. In the SNMP Port field, enter the port number on the device for SevOne NMS to poll SNMP data. The default is 161.

8. If you selected version 1 or version 2c above, provide input for the Read Community String and Write Community String fields. Then skip the next step. If you selected Version 3, proceed to the next step.

9. If you selected version 3 above, provide input for the Username, Password, and Authentication Type fields. If you select an Authentication Type other than NONE, you will be able to provide input for the Encryption Type field (and Encryption Key if applicable).

10. In the Test OID field, enter the OID to use to verify the SNMP settings.

11. In the Query Delay field, enter the number of seconds to wait after each SNMP command or query during discovery.

12. In the Query Delay (on failure) field, enter the number of seconds to wait after a failure of an SNMP command or query.

13. Click the Test this device's saved settings link if you would to display the SNMP Walk page. For more information on SNMP walks, please see SevOne's documentation on SNMP.

14. Click the Synchronize Interface Administrative Status drop-down and select an option.

15. On the right, click the Synchronize Interface Operational Status drop-down and select an option.

16. Click the Strict RFC 2233 Support drop-down and select an option.

17. Click the Prefer 64-bit Counters drop-down and select an option.

18. Select the IP/Interface Correlation check box to walk the ipAdEntAddr-like entries for IP address information.

19. Click the Trap Destination Discovery drop-down and select an option.

20. On the right, click the View Device Trap Destination Associations link to view the trap destinations available for the device.

21. Click the Max PDU Discovery drop-down and select an option.

22. Click the SNMP Walk Max Repetitions drop-down to choose either Default or Manual. If you choose the Manual option, Max Repetitions field becomes available which allows you to specify the maximum number of iterations over the repeating variables. Max Repetitions must be a positive integer between 1 and 30.

23. Click Edit Indicator Types to Monitor to display the SNMP Poller Indicator Type Mapping page if you would like to enable or disable the SNMP indicator types to poll on the device.

24. Once you are done, return to the Edit Device page.

IP SLA Plugin

1. Click the plugin drop-down and select IP SLA.
   

2. Select the Monitor IP SLA Data check box to enable discovery of IP SLA objects and to poll IP SLA data on the device.

3. The Version field cannot be edited. This is the round trip time monitoring application version string. The IP SLA plugin detects the version.

4. Select the Force Compliance Revision check box for the ability to change the Compliance Revision in the next step. The IP SLA plugin detects and enters the compliance revision for you. However, you can change the compliance revision for experimental purposes. If you select this check box, the IP SLA plugin uses the agent/OS you select and does not try to determine the proper agent/OS if the agent/OS you select fails.

5. Click the Compliance Revision drop-down and select an IP SLA revision. This step only applies if you selected the check box in the previous step. Click the Click here for more information link for the list of Cisco IP SLA Compliance Revisions.

6. Click the Enable responder drop-down and select one of the following options.

   • Auto - to use the setting from the Cluster Manager.

   • Yes - to turn on the IP SLA responder on the device, when possible.

   • No - to turn off the IP SLA responder on the device, when possible.

7. Responder status provides information about the status of the responder, either On, Off, or n/a. n/a indicates that a device is either new or has an operating system that does not support a responder.

8. Select the Allow SevOne to Issue Set Commands check box to allow SevOne NMS to automatically submit snmpset commands to the router in order to provision new IP SLAs.

9. Click Save to save changes.

Probe List

Perform the following steps to add and import probes.

1. From the navigation bar, click Applications and select Probe Manager.
   

2. On the Probes tab, click the Source Device drop-down and select a device. The devices displayed here have the IP SLA plugin enabled.

3. To the right of your selected device, you will see three icons. Click on an icon to perform one of the following actions.

   • - displays the the Device Summary for the selected source device.

   • - displays the Edit Device page for the selected source device.

   • - provisions the IP SLA test on the router.

4. Select one of the following options to specify which devices are displayed from the Source Device drop-down.
   

   • Only display devices with detected probes - displays only devices that SevOne NMS discovers at least one probe on.

   • Display all probe-capable devices - displays all devices that you enable the IP SLA plugin on.

5. On the right side of the tab, select the Only display probes provisioned by SevOne NMS check box to display only the probes that SevOne NMS provisions. Leave it clear to display all the probes for the selected source device.

The Probe List appears on the lower half of the Probe tab and provides the following information for the probes that meet your filter criteria. Each probe has a target device whose name or IP address displays in the Target separator bars in the probe list.

• Name - displays the name of the probe. Click on the name to display the Object Summary. The IP SLAs that SevOne NMS discovers use the following naming convention: SLA Type-Owner-Tag. For example, in the screenshot above, the name udpEcho-QAST-udp-echo is made up of three parts: udpEcho (SLA Type), QAST (Owner), and udp-echo (Tag).

• Description - displays the description of the probe. The probes that SevOne NMS discovers have descriptions based on the probes themselves.

• Type - displays the type of the probe as the enumeration form from the CISCO-RTT-MON MIB.

• Status - displays one of the following:

  • Discovered - when SevOne NMS runs the test and finds the result on devices that you enable the IP SLA plugin for.

  • Provisioned - when the device runs the test and sends the result back to SevOne NMS.

  • To Be Deleted - if you select to delete the probe.

• Actions - select one of the following:

  • - displays the IP SLA configuration for a probe.

  • - sets a probe to be deleted. When you delete a probe, it is removed from both SevOne NMS and the router.

    This option is not available for probes that SevOne NMS discovers–those probes cannot be deleted.

Add Probes

Perform the following actions to add a new probe.

1. Click Add Probe to display the Add Probe pop-up.
   

2. In the Name field, enter a name for the probe. Make sure that the name is unique for the selected device.

3. In the Description field, enter a description of the probe. This is for user information only and explains the purpose of the probe.
   

4. Click the IP SLA Type drop-down and select an IP SLA type from the following options. The type you select determines the specific configuration steps, which are listed below under each IP SLA type.

   IP SLA types that are not applicable for the selected device appear in light text and are not available for selection.

   • DHCP
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. In the Circuit ID field, enter the Cisco circuit ID as specified through the CLI. This is a hexadecimal value.

     6. In the Remote ID field, enter the remote ID. This is a hexadecimal value.

     7. In the Subnet Mask field, enter the Cisco extension to DHCP Option 82 that allows the specification of a subnet. This is a hexadecimal value.

     8. Click the Source IP drop-down and select the IP address of the source device.

   • DLSw
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

   • DNS
     
     

     1. In the Domain field, enter the complete valid URL of the DNS domain.

     2. In the Nameserver field, enter the IP address of the name server.

     3. Click + to expand the Advanced section.
        

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. Click the Source IP drop-down and select the IP address of the source device.

   • Echo
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     6. Click the Source IP drop-down and select the IP address of the source device.

   • Ethernet Jitter or Ethernet Ping
     
     

     1. In the MPID field, enter the destination maintenance point identifier (MPID) to test.

     2. In the Domain Name field, enter the domain where the destination maintenance point resides.

     3. In the Target VLAN field, enter identifier of the VLAN where the destination maintenance point resides.

     4. In the Target EVC field, enter the Ethernet Virtual Connection (EVC) where the maintenance point resides.

     5. Click + to expand the Advanced section.

     6. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     7. Ethernet Jitter only: In the Packet # field, enter the number of packets to send.

     8. Ethernet Jitter only: In the Interval field, specify in milliseconds the interval between packets.

     9. In the CoS field, enter the Ethernet class of service (CoS).

   • FTP
     
     

     1. In the URL field, enter the complete valid URL of the file to fetch. The beginning portion, ftp://, needs to be included. If a user name and password are required, use the format <username>:<password>@<webaddress>, for example:
        
        ftp://jerry:password@www.test.com/membersarea
        
        

     2. Click + to expand the Advanced section.

     3. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     4. In the ToS field, enter the type of service (ToS) for the FTP packets that are sent. This should be a number between 0 and 255.

     5. For Mode, select either Active or Passive.

     6. Click the Source IP drop-down and select the IP address to issue the request from. If a router has multiple interfaces and some interfaces do not have access to the FTP server, you will need to select the IP address of the interface that will issue the request. If you leave this blank, the router attempts to choose the best/closest interface–which may not be the interface you want.

   • HTTP
     
     

     1. In the URL field, enter the complete valid URL of the HTTP server.

     2. In the Nameserver field, enter the IP address of the name server.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     6. Click the Operation drop-down and select an operation.

     7. Click the HTTP Version drop-down and select the HTTP version.

     8. In the Proxy field, enter the IP address of the proxy.

     9. Select the Cache check box to cache the IP SLA.

     10. Click the Source IP drop-down and select the IP address of the source device.

   • ICMP Jitter
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     6. In the Packet # field, enter the number of packets to send.

     7. In the Interval field, specify in milliseconds the interval between packets.

     8. Click the Source IP drop-down and select the IP address of the source device.

   • RTP
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. Click the Codec drop-down and select the codec to use for the mean opinion score (MOS) and the impairment/calculated planning impairment factor (ICPIF) score.

     4. In the Source Voice Port field, enter the voice port name (for example, 0/1/1). This is not a TCP/UDP port number.

     5. In the ICPIF Factor field, enter the ICPIF factor number that determines the type of access and how the service is to be used. The following are ICPIF factor numbers.
        

        • 0 = Conventional Wire Line

        • 5 = Mobility within Building

        • 10 = Mobility within Geographic Area

        • 20 = Access to Hard-to-Reach Location

     6. Click + to expand the Advanced section.

     7. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     8. In the Duration field, enter the IP SLA duration.

     9. Click the Source IP drop-down and select the IP address of the source device.

   • TCP Connect or UDP Echo
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. In the Target Port field, enter the port number (between 0 and 65535) to connect to.

     4. Click + to expand the Advanced section.

     5. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     6. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     7. Click the Source IP drop-down and select the IP address of the source device.

   • UDP Jitter
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. In the Target Port field, enter the port number (between 0 and 65535) to connect to.

     4. Click the Codec drop-down and select the codec to use for the mean opinion score (MOS) and the impairment/calculated planning impairment factor (ICPIF) score.

     5. Click + to expand the Advanced section.

     6. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     7. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     8. In the Packet # field, enter the number of packets to send.

     9. In the Interval field, specify in milliseconds the interval between packets.

     10. Click the Precision drop-down and select the level of precision to measure at. The precision level that you select must be supported by the compliance revision (Revision 9 or later) of the sender and target IP SLA.

     11. Click the Source IP drop-down and select the IP address of the source device.

   • Video
     
     

     1. For Specify Target by, select one of the following:

        • Name - to select the name of the target device from a drop-down list in the next step.

        • IP Address - to enter the IP address of the target device in the next step.

     2. In the Target field, either click the drop-down and select the target device by name or enter the target device IP address in the text field, depending on your selection in the previous step.

     3. In the Target Port field, enter the port number (between 0 and 65535) to connect to.

     4. Click the Source drop-down and select the IP address of the source device.

     5. In the Source Port field, enter the port number of the source device.

     6. Click the Video Traffic Profile drop-down and select one of the following:

        • IPTV - indicates that the profile is for Internet Protocol television (IPTV), a system that uses the Internet Protocol suite to deliver television services over a packet-switched network, such as the Internet. This is opposed to traditional means of delivering television services–for example, over a terrestrial cable or via satellite signal.

        • IPVSC - indicates that the profile is for an IP surveillance camera

        • TELEPRESENCE - indicates that the profile is used for telepresence technologies, which enable people to feel as if they are present somewhere other than their actual location. Examples of telepresence technologies include video conferencing and telerobotics.

     7. Click + to expand the Advanced section.

     8. In the Frequency field, enter the number of seconds indicating how often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     9. In the Duration field, enter the IP SLA duration.

     10. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

   • VoIP
     
     

     1. Click the Detect Point drop-down and select the detect point.

     2. In the Called Number field, enter the telephone number called.

     3. Click + to expand the Advanced section.

     4. In the Frequency field, enter the number of seconds indicating often the router should perform the test. This needs to be greater than 0 and should be slightly less than the poll frequency of the device.

     5. In the ToS field, enter the type of service (ToS) byte number in the IP header of an IP SLA's operation. This should be a number between 0 and 255.

     6. Click the Source IP drop-down and select the IP address of the source device.

5. Click Save.

Import CSV

You can use the Probe CSV Importer to import probes into SevOne NMS. The steps for importing probes into SevOne NMS are below.

Before getting started, you will need to prepare a comma delimited file using the application of your choice. The .csv file(s) must be encoded in UTF-8. Make sure to complete all required fields. The IP SLA type entry determines which fields are required. Leave the fields that relate to other IP SLA types blank and delimited by the applicable number of commas. The following is a rundown of the required information for the .csv file, including:

• File format for required fields

• Conditionally required fields for specific probe types

• Fields required in the .csv file

• Fields that may be required in the .csv file

File format for the required fields:

Probe Type, Device Name, IP SLA Type, Name, Description, Frequency, Target, Target Port, ToS, Packet #, Packet Interval, Codec Type, Probe Precision, HTTP Version, URL, Nameserver, Proxy, Cache, Detect Point, Called Number

Format of conditionally required fields for specific probe types:

MPID, Domain Name, Target VLAN, CoS, Target EVC, Video Traffic Profile, Source Voice Port, ICPIF Factor, Duration, Source IP, Source Port, Mode, Circuit ID, Remote ID, Subnet Mask

The following lists provide descriptions of fields required for all IP SLA types, fields required by specific IP SLA types, and optional fields.

Fields required for all IP SLA types:

• Probe Type - (Required) Enter IP SLA.

• Device Name - (Required) Enter the name of a device that SevOne NMS discovers, including domain name and extension.

• IP SLA Type - (Required) Enter one of the following: dhcp, dlsw, dns, echo, ethernetJitter, ethernetPing, ftp, http, icmpjitter, rtp, tcpConnect, udpEcho, udpJitter, video, voip.
  

• Name - (Required) Enter the name for the probe.

• Description - (Required) Enter the description for the probe.

• Frequency - (Required) Enter a number greater than 0 to indicate how frequently the router should perform the test.

Fields required for specific SLA types:

• Target - (Required for DHCP, DLSw, Echo, ICMP Jitter, RTP, TCP Connect, UDP Echo, UDP Jitter, Video) Enter either the valid name of a device in SevOne NMS or a valid IPv4 address for the device.

• Target Port - (Required for TCP Connect, UDP Echo, UDP Jitter, Video) Enter a number between 0 and 65535.

• ToS - (Required for DLSw, Echo, FTP, HTTP, ICMP Jitter, TCP Connect, UDP Echo, UDP Jitter, Video, VoIP) Enter a number between 0 and 255.

• Packet # - (Required for Ethernet Jitter, ICMP Jitter, UDP Jitter) Enter a number.

• Packet Interval - (Required for Ethernet Jitter, ICMP Jitter, UDP Jitter) Enter a number.

• Codec Type - (Required for RTP, UDP Jitter) Enter one of the following: notApplicable, g711ulaw, g711alaw, g729a.

• Probe Precision - (Required for UDP Jitter) Enter one of the following: milliseconds, microseconds.

• HTTP Version - (Required for HTTP) Enter one of the following: 0.9, 1.0, 1.1.

• Target URL - (Required for FTP, HTTP) Enter a valid URL.

• Nameserver IP - (Required for DNS, HTTP) Enter a valid IPv4 address.

• Proxy - (Required for HTTP) Enter a valid IPv4 address.

• Cache - (Required for HTTP) Enter either On for enabled or Off for disabled.

• Detect Point - (Required for VoIP) Enter one of the following: voipDTAlertRinging, voipDTConnectOK.

• Called Number - (Required for VoIP) Enter a valid phone number.

• MPID - (Required for Ethernet Jitter, Ethernet Ping) Enter a number.

• Domain Name - (Required for DNS, Ethernet Jitter, Ethernet Ping) Enter a valid domain.

• Target VLAN - (Required for Ethernet Jitter, Ethernet Ping) Enter a number between 1 and 4095 (inclusive).

• CoS - (Required for Ethernet Jitter, Ethernet Ping) Enter a number between 0 and 255.

• Target EVC - (Required for Ethernet Jitter, Ethernet Ping) Enter a valid number.

• Video Traffic Profile - (Required for Video) Enter one of the following: IPTV, IPVSC, TELEPRESENCE.

• Source Voice Port - (Required for RTP) Enter a text string (for example, 0/1/1).

• ICPIF Factor - (Required for RTP) Enter a number between 0 and 20.

• Duration - (Required for RTP, Video) Enter a number.

• Source IP - (Required for DNS, Echo, FTP, HTTP, ICMP Jitter, RTP, TCP Connect, UDP Echo, UDP Jitter, Video, VoIP, DHCP) Enter a valid IPv4 address.
  

• Source Port - (Required for Video) Enter a number between 0 and 65535.

Optional fields

• Mode - (Optional for FTP) Enter Active or Passive. If left blank, this defaults to Passive.

• Circuit ID - (Optional for DHCP) Enter a hexadecimal number between 000000 and ffffff.

• Remote ID - (Optional for DHCP) Enter a hexadecimal number between 000000 and ffffff.

• Subnet Mask - (Optional for DHCP) Enter a hexadecimal number between 000000 and ffffff.

Once you have your comma delimited file ready, perform the following steps to import probes.

1. Under Probe List, click Import CSV to display the Probe CSV Importer pop-up.
   

2. Open your .csv file. Then copy and paste its contents into the Paste CSV data text field.

3. In the Paste CSV data text field, edit the information from the .csv file.

4. Click Save.

5. A message will appear below the Paste CSV data text field indicating whether or not the import was successful. If the import fails, the Error log field will appear, listing any error messages with the corresponding lines from the text field. SevOne NMS imports all probes that do not have errors. Fix any errors in the import file and repeat the steps above.

Messages

The Messages tab lets you view the messages that SevOne NMS generates during the discovery of probes. These messages occur each time SevOne NMS issues an snmpset command. They display the command and the result of any errors.

The following probe message data displays in the list.

• Probe Type - displays the probe type. Currently IP SLA is the only supported probe type.

• Device - displays the name of the source device.

• Time - displays the time when SevOne NMS sent the command.

• Original Message - displays the probe message.

• Success - displays Yes when the command is successful or No when the command is unsuccessful. Yes appears only for the first successful discovery of each probe.

• Retries - displays the number of retries.

Perform the following steps to view and manage messages.

1. Select the Messages tab.

2. Click the Source Device drop-down and select a device to view messages for it.

3. Select the check box for a message and do one of the following:
   

   • Click and select Retry Commands to retry the probe command.

   • Select Mark Successful to force the success to be marked as Yes.

   • Select Mark Unsuccessful to force the success to be marked as No.

   • Select Delete Selected to delete the probe message (you can select more than one message).

4. You can also retry the command by clicking on the Probe Type link. When you do this, the command displays in a pop-up. Click Retry to retry the command.