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


Use the PIM template for all vEdge Cloud and vEdge router devices.

To configure the PIM Sparse Mode (PIM-SM) protocol using vManage templates so that a router can participate in the Viptela multicast overlay network:

  1. Create a PIM feature template to configure PIM parameters, as described in this article.
  2. Optionally, create an IGMP feature template to allow individual hosts on the service side to join multicast groups within a particular VPN. See the IGMP help topic.
  3. Optionally, create a Multicast feature template to configure a vEdge router to be a multicast replicator. See the Multicast help topic.
  4. Create a VPN feature template to configure parameters for the VPN that is running PIM. See the VPN help topic.

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 Service VPN tab located directly beneath the Description field, or scroll to the Service VPN section.
  6. Click the Service VPN drop-down.

  7. Under Additional VPN Templates, located to the right of the screen, click PIM.
  8. From the PIM drop-down, click Create Template. The PIM template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining PIM parameters.
  9. 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.
  10. 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.

Configure Basic PIM

To configure PIM, select the Basic Configuration tab and configure the following parameters. Parameters marked with an asterisk are required to configure PIM.

Parameter Name Description
Shutdown* Ensure that No is selected, to enable PIM.

Click On to enable auto-RP to enable automatic discovery of rendezvous points (RPs) in the PIM network so that the router receivea group-to-RP mapping updates. By default, auto-RP is disabled.

SPT Threshold Specify the traffic rate, in kbps, at which to switch from the shared tree to the shortest-path tree (SPT). Configuring this value forces traffic to remain on the shared tree and travel via the RP instead of via the SPT.

For a topology that includes multicast replicators, determine how the replicator for a multicast group is chosen:

  • Random—Choose the replicator at random.
  • Sticky—Always use the same replicator. This is the default.

To save the feature template, click Save.

CLI equivalent:

vpn vpn-id
      [no] shutdown
      spt-threshold kbps

Configure PIM Interfaces

If the router is just a multicast replicator and is not part of a local network that contains either multicast sources or receivers, you do not need to configure any PIM interfaces. The replicator learns the locations of multicast sources and receivers from the OMP messages it exchanges with the vSmart controller. These control plane messages are exchanged in the transport VPN (VPN 0). Similarly, other vEdge routers discover replicators dynamically, through OMP messages from the vSmart controller.

To configure PIM interfaces, select the Interface tab. Then click Add New Interface and configure the following parameters:

Parameter Name Description
Name Enter the name of an interface that participates in the PIM domain, in the format geslot/port.
Hello Interval

Specify how often the interface sends PIM hello messages. Hello messages advertise that PIM is enabled on the router.
Range: 1 through 3600 seconds
Default: 30 seconds

Join/Prune Interval

Specify how often PIM multicast traffic can join or be removed from a rendezvous point tree (RPT) or shortest-path tree (SPT). vEdge routers send join and prune messages to their upstream RPF neighbor.
Range: 10 through 600 seconds
Default: 60 seconds

To edit an interface, click the pencil icon to the right of the entry.

To delete an interface, click the trash icon to the right of the entry.

To save the feature template, click Save.

CLI equivalent:

vpn vpn-id
      interface interface-name
        hello-interval seconds
        join-prune-interval seconds

Release Information

Introduced in vManage NMS in Release 15.2.

  • Was this article helpful?