| URI | Description |
|---|---|
| <base_URI>/config/running/router/pim/ | Configures basic global protocol-independent multicast (PIM) Sparse parameters on a device within the PIM Sparse domain. |
| GET URIs | Description |
|---|---|
| <base_URI>/config/running/router/pim/ | Basic global protocol-independent multicast (PIM) Sparse parameters on a device within the PIM Sparse domain. |
| <base_URI>/config/running/router/pim/max-mcache | Maximum multicast cache size. |
| <base_URI>/config/running/router/pim/hello-interval | Sets the frequency with which the device sends PIM hello messages to its neighbors. |
| <base_URI>/config/running/router/pim/prune-wait | Configures the time interval to wait for an override before pruning. |
| <base_URI>/config/running/router/pim/nbr-timeout | Sets neighbor timeout. |
| <base_URI>/config/running/router/pim/inactivity-timer | Sets inactivity interval. |
| <base_URI>/config/running/router/pim/message-interval | Sets periodic join/prune message interval. |
| <base_URI>/config/running/router/pim/spt-threshold | Sets threshold for switching to shortest-path-tree. |
| <base_URI>/config/running/router/pim/rpf | Reverse path to the source. |
| <base_URI>/config/running/router/pim/rpf/ecmp | Multicast ECMP load sharing. |
| <base_URI>/config/running/router/pim/rpf/ecmp/rebalance | Multicast ECMP load sharing with dynamic rebalancing. |
| <base_URI>/config/running/router/pim/ssm-enable | Enables SSM mode for PIM. |
| <base_URI>/config/running/router/pim/ssm-enable/range | Sets the multicast address range to use for SSM. |
| <base_URI>/config/running/router/pim/bsr-candidate | Sets candidate bootstrap router. |
| <base_URI>/config/running/router/pim/rp-candidate | Configures candidate rendezvous point (RP). |
| <base_URI>/config/running/router/pim/anycast-rp | Sets Anycast RP address and peers. |
| <base_URI>/config/running/router/pim/rp-address | Configures a device interface as a rendezvous point (RP). |
| <base_URI>/config/running/router/pim/rp-address/{IP-address}/prefix-list | Configures a device as a candidate rendezvous point (RP) for all multicast groups with the prefix 224.0.0.0/4, by default, and explicitly adds or deletes groups with other prefixes. |
| <base_URI>/config/running/router/pim/route-precedence | Specifies Route Selection criteria. |
GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.
The following example uses the GET option to retrieve the configuration details.
http://host:80/rest/config/running/router/pim
None
<pim xmlns="urn:brocade.com:mgmt:brocade-pim" xmlns:y="http://brocade.com/ns/rest" y:self="/rest/config/running/router/pim">
<max-mcache>24000</max-mcache>
<hello-interval>10</hello-interval>
<prune-wait>10</prune-wait>
<message-interval>30</message-interval>
<spt-threshold>0</spt-threshold>
<rpf y:self="/rest/config/running/router/pim/rpf">
<ecmp y:self="/rest/config/running/router/pim/rpf/ecmp">
<rebalance>true</rebalance>
</ecmp>
</rpf>
<bsr-candidate y:self="/rest/config/running/router/pim/bsr-candidate">
<interface y:self="/rest/config/running/router/pim/bsr-candidate/interface/loopback%2C3">
<bsr-cand-intf-type>loopback</bsr-cand-intf-type>
<bsr-cand-intf-id>3</bsr-cand-intf-id>
</interface>
</bsr-candidate>
<rp-candidate y:self="/rest/config/running/router/pim/rp-candidate">
<interface y:self="/rest/config/running/router/pim/rp-candidate/interface/loopback%2C3">
<rp-cand-intf-type>loopback</rp-cand-intf-type>
<rp-cand-intf-id>3</rp-cand-intf-id>
</interface>
<prefix y:self="/rest/config/running/router/pim/rp-candidate/prefix/pre1">
<rp-cand-prefix-name>pre1</rp-cand-prefix-name>
</prefix>
</rp-candidate>
<anycast-rp y:self="/rest/config/running/router/pim/anycast-rp/1.1.1.1">
<anycast-ip-addr>1.1.1.1</anycast-ip-addr>
</anycast-rp>
<rp-address y:self="/rest/config/running/router/pim/rp-address/135.135.135.135">
<rp-ip-addr>135.135.135.135</rp-ip-addr>
</rp-address>
<route-precedence y:self="/rest/config/running/router/pim/route-precedence">
<uc-default>true</uc-default>
<uc-non-default>true</uc-non-default>
</route-precedence>
</pim>