/system/vrfs/{name}/pim_routers/{ip_version}

put

https://switch-ip/rest/v10.08/system/vrfs/{name}/pim_routers/{ip_version}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

ip_version

string

required

Reference Resource: PIM_Router
PIM router entries keyed by IP version. This can have one PIM_Router entry per IP version.

Body Params

sources_per_group

int64

1 to 4294967295

Total number of sources allowed for a group on this router. By default, there is no limit on the number of sources for a group. When the number of sources for a group exceeds the configured limit, multicast traffic from additional sources will be dropped.

candidate_bsr_priority

integer

0 to 255

Candidate-BSR's priority on this router.

candidate_rp_priority

integer

0 to 255

Candidate-RP's priority on this router.

state_refresh

integer

10 to 100

Periodic interval (in seconds) at which state refresh datagrams are transmitted by this router. This is applicable when PIM mode is set to 'dense'.

active_active

boolean

Enables PIM active-active feature on the PIM router which is part of VSX pair. If the value is true, then the VSX peer which is not forwarding the multicast traffic, acts as proxy-DR and learns multicast routes. The multicast routes in proxy-DR would be written as bridge entries in the hardware. If the value is false, then PIM active-active feature would be turned off. In this case, if the VSX peer which is forwarding the multicast stream goes down, other peer would send joins only after the neighbor expiry. So it takes time to resume multicast traffic.

rpf_override

object

Reference Resource: Static_Multicast_Nexthop
Overrides normal RPF lookup mechanism for multicast routes matching ip_prefix IP-ADDR/MASK-LEN with the gateway ip/port

candidate_bsr_hash_mask_length

integer

1 to 128

Candidate-BSR's hash mask length on this router.

rp_group_acls

object

Reference Resource: ACL
Ingress ACL to filter PIM join and prune messages received from peer devices based on the RP address and its associated (S, G) information specified in those messages. When this is not configured, all PIM join and prune messages will be processed.

spt_threshold_disable

boolean

Enables Shortest Path Tree(SPT) switching on this router.

candidate_rp_holdtime

integer

30 to 255

Candidate-RP's Holdtime (in seconds) on this router.

mroutes_limit

int64

1 to 4294967295

Limit on the maximum number of multicast route entries that can be programmed. When the limit is configured, multicast route entries created because of IGMP or MLD membership reports and multicast route entries created because of multicast streams are restricted under the configured limit.

register_acl

string

Reference Resource: ACL
Ingress ACL to filter processing of PIM register messages received from peer devices. When this is not configured, all PIM register messages will be processed.

router_enable

boolean

Enables PIM protocol on this router.

ip_version

string

required

Reference Resource: PIM_Router
PIM router entries keyed by IP version. This can have one PIM_Router entry per IP version.

clear_mroute_request

array of strings

length ≤ 9223372036854776000

Reference Resource: PIM_Clear_Mroute_Request
List of clear requests associated with Multicast route entries.

clear_mroute_request

pim_static_rps

object

Reference Resource: PIM_Static_RP
Static RPs for the specified multicast prefixes expressed as (IP-ADDR/MASK-LEN) and PIM_Static_RP entry. There can exist only one RP address for a unique group prefix.

candidate_rp_adv_interval

integer

30 to 600

Periodic interval(in seconds) at which the Candidate-RP advertisements are originated from this router.

candidate_rp_group_prefix

array of strings

length ≤ 4

Multicast group prefix associated with this Candidate-RP. The entries are valid only when candidate_rp_port is configured. An empty value with a valid Candidate-RP port in candidate_rp_port means that this Candidate-RP is handling all the possible multicast groups. This entries will take the format IP-ADDR/MASK-LEN.

candidate_rp_group_prefix

candidate_bsr_port

string

Reference Resource: Port
Candidate Bootstrap Router (Candidate-BSR) port on this router. Candidate-BSR Port must be specified to enable BSR operations. IP address of this port will be advertised as the Candidate-BSR address.

candidate_bsr_bsm_interval

integer

5 to 300

Periodic interval(in seconds) at which the BSMs are originated from this router.

bfd_all_interfaces_enable

boolean

Enables BFD on all PIM interfaces.

register_messages_limit

int64

1 to 4294967295

Limit on the maximum number of register messages sent per second for every unique (S,G) entry. By default, there is no maximum rate set. When the limit is configured, register messages generated exceeding the configured limit will be suppressed.

join_prune_interval

integer

5 to 65535

Frequency (in seconds) at which this router sends PIM Join/Prune messages.

candidate_rp_port

string

Reference Resource: Port
Candidate Rendezvous Point (Candidate-RP) port on this router. Candidate-RP Port must be specified to enable Candidate-RP operations.

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Loading…