routing/pimsm
Conditions: !smips
Type: Directory
routing/pimsm/instance
Conditions: !smips
Type: Directory
The instance menu defines the main PIM-SM settings. The instance is then used for all other PIM-related configurations like interface-template, static RP, and Bootstrap Router.
| Flag | Name | Description |
|---|
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|
| vrf | enum | Name of the VRF for control connections. |
| name | string | Name of the instance. |
| afi | enum (ip | ipv6) | Specifies address family for PIM. |
| switch-to-spt | bool | Whether to switch to Shortest Path Tree (SPT) if multicast data bandwidth threshold is reached. The router will not proceed from protocol phase one (register encapsulation) to native multicast traffic flow if this option is disabled. It is recommended to enable this option. |
| switch-to-spt-interval | time | Time interval in which to account for multicast data bandwidth, used in conjunction with switch-to-spt-bytes to determine if the switching threshold is reached. |
| switch-to-spt-bytes | num | Multicast data bandwidth threshold. Switching to Shortest Path Tree (SPT) happens if this threshold is reached in the specified time interval. If a value of 0 is configured, switching will happen immediately. |
| crp-advertise-contained | bool | Currently not implemented. |
| bsm-forward-back | bool | Currently not implemented. |
| rp-hash-mask-length | num | The hash mask allows changing how many groups to map to one of the matching RPs. |
| rp-static-override | bool | Changes the selection priority for static RP. When disabled, the bootstrap RP set has a higher priority. When enabled, static RP has a higher priority. |
| ssm-range | address (flags=46/) | Currently not implemented. |
routing/pimsm/interface-template
Conditions: !smips
Type: Directory
The interface template menu defines which interfaces will participate in PIM and what per-interface configuration will be used.
| Flag | Name | Description |
|---|
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|
| instance ( mandatory ) | enum | Name of the PIM instance this interface template belongs to. |
| interfaces ( unset ) | obj_arg { interface_enum { } { }
} | List of interfaces that will participate in PIM. |
| hello-period | time | Periodic interval for Hello messages. |
| hello-delay | time | Randomized interval for the initial Hello message on interface startup or detecting a new neighbor. |
| priority | num | The Designated Router (DR) priority. A single Designated Router is elected on each network. The priority is used only if all neighbors have advertised a priority option. The numerically largest priority is preferred. In case of a tie or if priority is not used - the numerically largest IP address is preferred. |
| join-prune-period | time | |
| propagation-delay | time | Sets the value for a prune pending timer. It is used by upstream routers to figure out how long they should wait for a Join override message before pruning an interface that has join suppression enabled. |
| override-interval | time | Sets the maximum time period over which to randomize when scheduling a delayed override Join message on a network that has join suppression enabled. |
| join-tracking-support | bool | Sets the value of a Tracking (T) bit in the LAN Prune Delay option in the Hello message. When enabled, a router advertises its willingness to disable Join suppression. It is possible for upstream routers to explicitly track the join membership of individual downstream routers if Join suppression is disabled. Unless all PIM routers on a link negotiate this capability, explicit tracking and the disabling of the Join suppression mechanism are not possible. |
| source-addresses ( unset ) | obj_arg { address (flags=46)
} | |
routing/pimsm/igmp-interface-template
Conditions: !smips
Type: Directory
| Argument | Type | Description |
|---|
| instance ( mandatory ) | enum | |
| interfaces ( unset ) | obj_arg { interface_enum { } { }
} | |
routing/pimsm/interface
Conditions: !smips
Type: Directory
The interface menu shows all interfaces that are currently participating in PIM and their statuses. This menu contains dynamic and read-only entries that get created by defined interface templates.
| Flag | Name | Description |
|---|
| D | dynamic | dynamic |
| P | designated-router | designated-router |
| J | join-tracking | join-tracking |
| Read-only Argument | Type | Description |
|---|
| instance | enum | |
| interface | interface_enum | |
| address | address (flags=46) | |
| dr | switch | |
| join-tracking | switch | |
| priority | num | |
| propogation-delay | time | |
| override-interval | time | |
routing/pimsm/neighbor
Conditions: !smips
Type: Directory
The neighbor menu shows all detected neighbors that are running PIM and their statuses. This menu contains dynamic and read-only entries.
| Flag | Name | Description |
|---|
| R | designated-router | designated-router |
| J | join-tracking | join-tracking |
| Read-only Argument | Type | Description |
|---|
| instance | enum | Name of the PIM instance this neighbor is detected on. |
| address | address (flags=46i) | Shows the neighbor's IP address and local interface the neighbor is detected on. |
| priority | num | Indicates the neighbor's priority value. |
| timeout | time | Shows the remaining time after the neighbor is removed from the list if no new Hello message is received. The hold time equals neighbor's hello-period * 3.5. |
| designated-router | bool | Shows whether the neighbor is elected as Designated Router (DR). |
| propagation-delay | time | Indicates the neighbor's value of the propagation delay in the LAN Prune Delay option in the Hello message. |
| override-interval | time | Indicates the neighbor's value of the override interval in the LAN Prune Delay option in the Hello message. |
| join-tracking | bool | Indicates the neighbor's value of a Tracking (T) bit in the LAN Prune Delay option in the Hello message. |
routing/pimsm/static-rp
Conditions: !smips
Type: Directory
The static-rp menu allows manually defining the multicast group to RP mappings. Such a mechanism is not robust to failures but does at least provide a basic interoperability mechanism.
| Flag | Name | Description |
|---|
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|
| instance ( mandatory ) | enum | The name of the PIM instance this static RP belongs to. |
| group | address (flags=46/) | The multicast group that belongs to a specific RP. |
| address | address (flags=46) | The IP address of the static RP. |
routing/pimsm/uib-g
Conditions: !smips
Type: Directory
The upstream information base menus show the any-source multicast (*,G) and source-specific multicast (S,G) groups and their statuses. These menus contain only read-only entries.
| Flag | Name | Description |
|---|
| R | rp-local | rp-local |
| Read-only Argument | Type | Description |
|---|
| instance | enum | Name of the PIM instance the multicast group is created on. |
| group | address (flags=46i) | The multicast group address. |
| rp | address (flags=46i) | The address of the Rendezvous Point for this group. |
| rpf | address (flags=46i) | The Reverse Path Forwarding (RPF) indicates the router address and outgoing interface that a Join message for that group is directed to. |
| rp-local | bool | Indicates whether the multicast router itself is the RP. |
routing/pimsm/uib-sg
Conditions: !smips
Type: Directory
missing spt-bit The Shortest Path Tree (SPT) bit indicates whether forwarding is taking place on the (S,G) Shortest Path Tree or on the (*,G) tree. A router can have an (S,G) state and still be forwarding on a (*,G) state during the interval when the source-specific tree is being constructed. When the SPT bit is false, only the (*,G) forwarding state is used to forward packets from S to G. When the SPT bit is true, both (*,G) and (S,G) forwarding states are used.
| Flag | Name | Description |
|---|
| K | keepalive | keepalive |
| S | spt-bit | spt-bit |
| Read-only Argument | Type | Description |
|---|
| instance | enum | Name of the PIM instance the multicast group is created on. |
| group | address (flags=46i) | The multicast group address. |
| source | address (flags=46i) | The source IP address of the multicast group. |
| rpf | address (flags=46i) | The Reverse Path Forwarding (RPF) indicates the router address and outgoing interface that a Join message for that group is directed to. |
| register | enum (join | join-pending | prune) | |
routing/pimsm/bsr
Conditions: !smips
Type: Directory
| Flag | Name | Description |
|---|
| D | dynamic | dynamic |
| Read-only Argument | Type | Description |
|---|
| instance | enum | |
| scope4 ( unset ) | address (flags=4/) | |
| scope6 ( unset ) | num | |
| address | address (flags=46) | |
| priority | num | |
| hash-mask-length | num | |
| state | enum (accept-any | accept-preferred | candidate | pending | elected) | |
routing/pimsm/bsr/candidate
Conditions: !smips
Type: Directory
| Flag | Name | Description |
|---|
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|
| instance | enum | |
| address | address (flags=46i) | |
| scope4 ( unset ) | address (flags=4/) | |
| scope6 ( unset ) | num | |
| priority | num | |
| hashmask-length | num | |
| Read-only Argument | Type | Description |
|---|
| state | enum (candidate | pending | elected) | |
routing/pimsm/bsr/rp-candidate
Conditions: !smips
Type: Directory
| Flag | Name | Description |
|---|
| X | disabled | disabled |
| I | inactive | inactive |
| Argument | Type | Description |
|---|
| instance | enum | |
| group | address (flags=46/) | |
| address | address (flags=46i) | |
| priority | num | |
| holdtime | num | |
routing/pimsm/bsr/rp-set
Conditions: !smips
Type: Directory
| Read-only Argument | Type | Description |
|---|
| instance | enum | |
| group | address (flags=46/v) | |
| rp.address | obj_arg { address (flags=46)
} | |
| rp.priority | obj_arg { num
} | |
| rp.timeout | obj_arg { time
} | |