router : multicast : config interface
 
config interface
Use this subcommand to change interface-related PIM settings, including the mode of operation (sparse or dense). Global settings do not override interface-specific settings.
All fields are optional.
 
Variable
Description
Default
edit <interface_name>
Enter the name of the FortiGate unit interface on which to enable PIM protocols.
No default.
cisco-exclude-genid {enable | disable}
This field applies only when pim-mode is sparse-mode.
Enable or disable including a generation ID in hello messages sent to neighboring PIM routers. A GenID value may be included for compatibility with older Cisco IOS routers.
disable
dr-priority <priority_integer>
This field applies only when pim-mode is sparse-mode.
Assign a priority to FortiGate unit Designated Router (DR) candidacy. The range is from 1 to 4 294 967 294. The value is compared to that of other DR interfaces connected to the same network segment, and the router having the highest DR priority is selected to be the DR. If two DR priority values are the same, the interface having the highest IP address is selected.
1
hello-holdtime <holdtime_integer>
Specify the amount of time (in seconds) that a PIM neighbor may consider the information in a hello message to be valid. The range is from 1 to 65 535.
If the hello-interval attribute is modified and the hello-holdtime attribute has never been set explicitly, the hello-holdtime attribute is automatically set to 3.5 x hello-interval.
105
hello-interval <hello_integer>
Set the amount of time (in seconds) that the FortiGate unit waits between sending hello messages to neighboring PIM routers. The range is from 1 to 65 535.
Changing the hello-interval attribute may automatically update the hello-holdtime attribute .
30
multicast-flow <flowname>
Connect the named multicast flow to this interface. Multicast flows are defined in the router multicast-flow command.
No default.
neighbour-filter <access_list_name>
Establish or terminate adjacency with PIM neighbors having the IP addresses given in the specified access list. For more information on access lists, see router access-list, access-list6.
Null
passive {enable | disable}
Enable or disable PIM communications on the interface without affecting IGMP communications.
disable
pim-mode {sparse-mode | dense-mode}
Select the PIM mode of operation. Choose one of:
sparse-mode — manage PIM packets through distribution trees and multicast groups.
dense-mode — enable multicast flooding.
sparse-mode
propagation-delay <delay_integer>
This field is available when pim-mode is set to dense‑mode.
Specify the amount of time (in milliseconds) that the FortiGate unit waits to send prune-override messages. The range is from 100 to 5 000.
500
rp-candidate {enable | disable}
This field is available when pim-mode is set to sparse‑mode.
Enable or disable the FortiGate unit interface to offer Rendezvous Point (RP) services.
disable
rp-candidate-group <access_list_name>
RP candidacy is advertised to certain multicast groups. These groups are based on the multicast group prefixes given in the specified access list. For more information on access lists, see “access-list, access-list6”.
This field is available when rp-candidate is set to enable and pim-mode is set to sparse‑mode.
Null
rp-candidate-interval <interval_integer>
This field is available when rp-candidate is set to enable and pim-mode is set to sparse‑mode.
Set the amount of time (in seconds) that the FortiGate unit waits between sending RP announcement messages. The range is from 1 to 16 383.
60
rp-candidate-priority <priority_integer>
This field is available when rp-candidate is set to enable and pim-mode is set to sparse‑mode.
Assign a priority to FortiGate unit Rendezvous Point (RP) candidacy. The range is from 0 to 255. The BSR compares the value to that of other RP candidates that can service the same multicast group, and the router having the highest RP priority is selected to be the RP for that multicast group. If two RP priority values are the same, the RP candidate having the highest IP address on its RP interface is selected.
192
state-refresh-interval <refresh_integer>
This field is available when pim-mode is set to dense‑mode.
This attribute is used when the FortiGate unit is connected directly to the multicast source. Set the amount of time (in seconds) that the FortiGate unit waits between sending state-refresh messages. The range is from 1 to 100. When a state-refresh message is received by a downstream router, the prune state on the downstream router is refreshed.
60
static-group <flowname>
Statically join this interface to the named multicast group. The interface does not need to have seen any IGMP joins from any host. Multicast flows are defined in the router multicast-flow command.
No default.
ttl-threshold <ttl_integer>
Specify the minimum Time-To-Live (TTL) value (in hops) that an outbound multicast packet must have in order to be forwarded from this interface. The range is from 0 to 255.
Specifying a high value (for example, 195) prevents PIM packets from being forwarded through the interface.
1
config join-group variables
edit address <address_ipv4>
Cause the FortiGate unit interface to activate (IGMP join) the multicast group associated with the specified multicast group address.
No default.
config igmp variables
access-group <access_list_name>
Specify which multicast groups that hosts on the connected network segment may join based on the multicast addresses given in the specified access list. For more information on access lists, see router access-list, access-list6.
Null.
immediate-leave-group <access_list_name>
This field applies when version is set to 2 or 3.
Configure a FortiGate unit DR to stop sending traffic and IGMP queries to receivers after receiving an IGMP version 2 group-leave message from any member of the multicast groups identified in the specified access list. For more information on access lists, see router access-list, access-list6.
Null.
last-member-query-count <count_integer>
This field applies when version is set to 2 or 3.
Specify the number of times that a FortiGate unit DR sends an IGMP query to the last member of a multicast group after receiving an IGMP version 2 group-leave message.
2
last-member-query-interval <interval_integer>
This field applies when version is set to 2 or 3.
Set the amount of time (in milliseconds) that a FortiGate unit DR waits for the last member of a multicast group to respond to an IGMP query. The range is from 1000 to 25 500. If no response is received before the specified time expires and the FortiGate unit DR has already sent an IGMP query last-member-query-count times, the FortiGate unit DR removes the member from the group and sends a prune message to the associated RP.
1000
query-interval <interval_integer>
Set the amount of time (in seconds) that a FortiGate unit DR waits between sending IGMP queries to determine which members of a multicast group are active. The range is from 1 to 65 535.
125
query-max-response-time <time_integer>
Set the maximum amount of time (in seconds) that a FortiGate unit DR waits for a member of a multicast group to respond to an IGMP query. The range is from 1 to 25. If no response is received before the specified time expires, the FortiGate unit DR removes the member from the group.
10
query-timeout <timeout_integer>
Set the amount of time (in seconds) that must expire before a FortiGate unit begins sending IGMP queries to the multicast group that is managed through the interface. The range is from 60 to 300. A FortiGate unit begins sending IGMP queries if it does not receive regular IGMP queries from another DR through the interface.
255
router-alert-check { enable | disable }
Enable to require the Router Alert option in IGMP packets.
disabled
version {1 | 2 | 3}
Specify the version number of IGMP to run on the interface. The value can be 1, 2, or 3. The value must match the version used by all other PIM routers on the connected network segment.
3