Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

SNMP

Use the SNMP template to configure SNMP parameters for all Viptela devices.

Note: A single device template can contain only one SNMP feature template. So in a single device template you can configure either SNMPv2 or SNMPv3, but not both.

Navigate to the Template Screen and Name the Template

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. In the Device tab, click Create Template.
  3. From the Create Template drop-down, select From Feature Template.
  4. From the Device Model drop-down, select the type of device for which you are creating the template.
  5. Click the Additional Templates tab located directly beneath the Description field, or scroll to the Additional Templates section.
  6. From the SNMP drop-down, click Create Template. The SNMP template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining SNMP parameters.
  7. In the Template Name field, enter a name for the template. The name can be up to 128 characters and can contain only alphanumeric characters.
  8. In the Template Description field, enter a description of the template. The description can be up to 2048 characters and can contain only alphanumeric characters.

When you first open a feature template, for each parameter that has a default value, the scope is set to Default (indicated by a check mark), and the default setting or value is shown. To change the default or to enter a value, click the scope drop-down to the left of the parameter field and select one of the following:

Parameter Scope

Scope Description

Device Specific (indicated by a host icon)

Use a device-specific value for the parameter. For device-specific parameters, you cannot enter a value in the feature template. You enter the value when you attach a Viptela device to a device template.

When you click Device Specific, the Enter Key box opens. This box displays a key, which is a unique string that identifies the parameter in a CSV file that you create. This file is an Excel spreadsheet that contains one column for each key. The header row contains the key names (one key per column), and each row after that corresponds to a device and defines the values of the keys for that device. You upload the CSV file when you attach a Viptela device to a device template. For more information, see Create a Template Variables Spreadsheet.

To change the default key, type a new string and move the cursor out of the Enter Key box.

Examples of device-specific parameters are system IP address, hostname, GPS location, and site ID.

Global (indicated by a globe icon)

Enter a value for the parameter, and apply that value to all devices.

Examples of parameters that you might apply globally to a group of devices are DNS server, syslog server, and interface MTUs.

Configuring Basic SNMP

To configure basic SNMP, select the SNMP tab and configure the following parameters. All parameters are required.

Parameter Name Description
Shutdown Click No to enable SNMP. By default, SNMP is disabled.
Name of Device for SNMP Enter a name for the Viptela device to identify it in SNMP notifications.
Contact Person Enter the name of the network management contact person in charge of managing the Viptela device. It can be a maximum of 255 characters.
Location of Device Enter a description of the location of the device. It can be a maximum of 255 characters.

To save the feature template, click Save.

CLI equivalent:

snmp
  contact string  
  location string  
  name string
  [no] shutdown

Configure SNMPv2

To configure SNMPv2, select the SNMP Version tab and click V2. For SNMPv2, you can configure communities and trap information.

To configure SNMP views, in the View & Community section, select the View tab. Then click Add New View, and configure the following parameters:

Parameter Name Description
Name Enter a name for the view. A view specifies the MIB objects that the SNMP manager can access. The view name can be a maximum of 255 characters. You must add a view name for all views before adding a community.
Object Identifiers

Click Add Object Identifiers and configure the following parameters:

  • Exclude OID—Enter the OID of the object. For example, to view the Internet portion of the SNMP MIB, enter the OID 1.3.6.1. To view the private portion of the Viptela MIB, enter the OID 1.3.6.1.4.1.41916. Use the asterisk wildcard (*) in any position of the OID subtree to match any value at that position rather than matching a specific type or name.
  • On/Odd—Click Off to include the OID in the view or click On to exclude the OID from the view.

To save the object identifiers, click Save.

To remove an OID from the list, click the minus sign to the right of the entry.

To add the SNMP view, click Add.

To configure the SNMP community, select the Community tab. Then click Add New Community, and configure the following parameters:

Parameter Name Description
Name

Enter the name for the community. The name can be from 1 through 32 characters and can include angle brackets (< and >).

Authorization Select read-only from the dropdown list. The MIBs supported by the Viptela software do not allow write operations, so you can configure only read-only authorization.
View Select a view to apply to the community. The view specifies the portion of the MIB tree the community can access.

To add the SNMP community, click Add.

To configure trap, in the Trap section, select the Trap Group tab. Then click Add New Trap Group, and configure the following parameters:

Parameter Name Description
Group Name Enter a name for the trap group. It can be from 1 to 32 characters long.
Trap Type Modules

Click Add Trap Type Modules, and configure the following parameters:

In Severity Levels, select one or more severity levels for the trap—critical, major, or minor.

In Module Name, select the type of traps to include in the trap group:

  • all—All trap types.
  • app-route—Traps generated by application-aware routing.
  • bfd—Traps generated by BFD and BFD sessions.
  • control—Traps generated by DTLS and TLS sessions.
  • dhcp—Traps generated by DHCP.
  • hardware—Traps generated by Viptela hardware.
  • omp—Traps generated by OMP.
  • routing—Traps generated by BGP, OSPF, and PIM.
  • security—Trap generated by certificates, vSmart and vEdge serial number files, and IPsec.
  • system—Traps generated by system-wide functions.
  • vpn—Traps generated by VPN-specific functions, including interfaces and VRRP.

To save the trap type module, click Save.

To configure trap target servers, in the Trap section, select the Trap Target Server tab. Then click Add New Trap Group, and configure the following parameters:

Parameter Name Description
VPN ID Enter the number of the VPN to use to reach the trap server.
Range: 0 through 65530
IP Address Enter the IP address of the SNMP server.
UDP Port Enter the UDP port number for connecting to the SNMP server.
Range: 1 though 65535
Group Name Select the name of a trap group that was configured under the Group tab.
Community Name Select the name of a community that was configured under the Community tab.
Source Interface Enter the interface to use to send traps to the SNMP server that is receiving the trap information.

To save the trap target, click Add

To save the feature template, click Save.

CLI equivalent:

snmp
  community name    
    authorization (read-only | read-write)
    view string 
  trap
    group group-name
      trap-type
        level severity
    target vpn vpn-id ip-address udp-port
      community-name community-name
      group-name name
  view string    
    oid oid-number [exclude]

Configure SNMPv3

To configure SNMPv3, in SNMP Version, click V3. For SNMPv3, you can configure groups, users, and trap information. Configure groups and trap information as described above.

To confgure SNMPv3 users, in the User section, click Add New User and enter the following parameters:

Parameter Name Description
User

Enter a name of the SNMP user. It can be 1 to 32 alphanumeric characters.

Authentication Protocol

Select the authentication mechanism for the user:

  • MD5—Use message digest 5.
  • SHA—Use SHA-2 message digest.
Authentication Password

Enter the authentication password either in cleartext or as an AES-encrypted key.

Privacy Protocol

Select the privacy type for the user:

  • AES-CFB-128—Use Advanced Encryption Standard cipher algorithm used in cipher feedback mode, with a 128-bit key.
Privacy Password Enter the authentication password either in cleartext or as an AES-encrypted key.
Group Select the name of a configure SNMPv3 group.

To save the user, click Add.

To save the feature template, click Save.
CLI equivalent:

snmp
  group group-name authentication
    view string
  trap
    group group-name
      trap-type
        level severity
    target vpn vpn-id ip-address udp-port
      community-name community-name
      group-name name
  user username
    auth authentication
    auth-password password
    group group-name
    priv privacy
    priv-password password

Release Information

Introduced in vManage NMS in Release 15.2.
In Release 16.2, add support for SNMPv3.
In Release 17.2, remove support for DES privacy for the SNMP user.

  • Was this article helpful?