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


You can 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 Configuration ► Templates ► IGMP help topic.
  3. Optionally, create a Multicast feature template to configure a vEdge router to be a multicast replicator. See the Configuration ► Templates ► Multicast help topic.
  4. Create a VPN feature template to configure parameters for the VPN that is running PIM. See the Configuration ► Templates ► VPN help topic.
  5. Create a device template that incorporates the multicast, PIM, and VPN feature templates. See the Configuration ► Templates help topic.​​

Navigate to the Template Screen

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. From the Templates title bar, select Feature.
  3. Click Add Template.
  4. In the left pane, select one or more devices. The right pane displays the available templates for the selected devices.
  5. Select the PIM template.

The right pane displays the PIM template form:

  • The top of the form contains fields for naming the template.
  • The bottom contains fields for defining parameters applicable to that template.
  • A drop-down menu to the left of each parameter field defines the scope of the parameter. When you first open a feature template form, for each parameter that has a default value, the scope is set to Default. To edit a parameter field, change the scope to Global or Device Specific. Note that if a parameter's scope is Device Specific, you cannot enter a value for it in the feature template. Instead, you enter a value when you attach the template to a device.
  • A plus sign (+) is displayed to the right when you can add multiple entries for the same parameter.

Minimum PIM Configuration

The following parameters are required (unless otherwise indicated) to configure PIM on a vEdge router:

Step Parameter Name Description
 1. Template Name Enter a name for the template. It can be up to 128 characters and can contain only alphanumeric characters.
 2. Description (Template) Enter a description for the template. It can be up to 2048 characters and can contain only alphanumeric characters.
 3. Shutdown Ensure that No is selected, to enable PIM.
 4. Auto-RP (optional)

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.

 5. SPT threshold (optional) 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.
 6. Replicator Selection (optional)

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.
 7. Interface Configure the interfaces participating in the PIM network. See the following section.
 8. Save Click Save to save the feature template.

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, click the plus sign (+):

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

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 add another interface, click the plus sign (+).

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

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?