Fortinet black logo

CLI Reference

config router multicast

config router multicast

Configure router multicast.

config router multicast
    Description: Configure router multicast.
    config interface
        Description: PIM interfaces.
        edit <name>
            set ttl-threshold {integer}
            set pim-mode [sparse-mode|dense-mode]
            set passive [enable|disable]
            set bfd [enable|disable]
            set neighbour-filter {string}
            set hello-interval {integer}
            set hello-holdtime {integer}
            set cisco-exclude-genid [enable|disable]
            set dr-priority {integer}
            set propagation-delay {integer}
            set state-refresh-interval {integer}
            set rp-candidate [enable|disable]
            set rp-candidate-group {string}
            set rp-candidate-priority {integer}
            set rp-candidate-interval {integer}
            set multicast-flow {string}
            set static-group {string}
            set rpf-nbr-fail-back [enable|disable]
            set rpf-nbr-fail-back-filter {string}
            config join-group
                Description: Join multicast groups.
                edit <address>
                next
            end
            config igmp
                Description: IGMP configuration options.
                set access-group {string}
                set version [3|2|...]
                set immediate-leave-group {string}
                set last-member-query-interval {integer}
                set last-member-query-count {integer}
                set query-max-response-time {integer}
                set query-interval {integer}
                set query-timeout {integer}
                set router-alert-check [enable|disable]
            end
        next
    end
    set multicast-routing [enable|disable]
    config pim-sm-global
        Description: PIM sparse-mode global settings.
        set message-interval {integer}
        set join-prune-holdtime {integer}
        set accept-register-list {string}
        set accept-source-list {string}
        set bsr-candidate [enable|disable]
        set bsr-interface {string}
        set bsr-priority {integer}
        set bsr-hash {integer}
        set bsr-allow-quick-refresh [enable|disable]
        set cisco-register-checksum [enable|disable]
        set cisco-register-checksum-group {string}
        set cisco-crp-prefix [enable|disable]
        set cisco-ignore-rp-set-priority [enable|disable]
        set register-rp-reachability [enable|disable]
        set register-source [disable|interface|...]
        set register-source-interface {string}
        set register-source-ip {ipv4-address}
        set register-supression {integer}
        set null-register-retries {integer}
        set rp-register-keepalive {integer}
        set spt-threshold [enable|disable]
        set spt-threshold-group {string}
        set ssm [enable|disable]
        set ssm-range {string}
        set register-rate-limit {integer}
        set pim-use-sdwan [enable|disable]
        config rp-address
            Description: Statically configure RP addresses.
            edit <id>
                set ip-address {ipv4-address}
                set group {string}
            next
        end
    end
    set route-limit {integer}
    set route-threshold {integer}
end

config router multicast

Parameter

Description

Type

Size

Default

multicast-routing

Enable/disable IP multicast routing.

option

-

disable

Option

Description

enable

Enable IP multicast routing.

disable

Disable IP multicast routing.

route-limit

Maximum number of multicast routes.

integer

Minimum value: 1 Maximum value: 2147483647

2147483647

route-threshold

Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.

integer

Minimum value: 1 Maximum value: 2147483647

config interface

Parameter

Description

Type

Size

Default

name

Interface name.

string

Maximum length: 15

ttl-threshold

Minimum TTL of multicast packets that will be forwarded.

integer

Minimum value: 1 Maximum value: 255

1

pim-mode

PIM operation mode.

option

-

sparse-mode

Option

Description

sparse-mode

sparse-mode

dense-mode

dense-mode

passive

Enable/disable listening to IGMP but not participating in PIM.

option

-

disable

Option

Description

enable

Listen only.

disable

Participate in PIM.

bfd

Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

option

-

disable

Option

Description

enable

Enable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

disable

Disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

neighbour-filter

Routers acknowledged as neighbor routers.

string

Maximum length: 35

hello-interval

Interval between sending PIM hello messages.

integer

Minimum value: 1 Maximum value: 65535

30

hello-holdtime

Time before old neighbor information expires.

integer

Minimum value: 1 Maximum value: 65535

cisco-exclude-genid

Exclude GenID from hello packets (compatibility with old Cisco IOS).

option

-

disable

Option

Description

enable

Do not send GenID.

disable

Send GenID according to standard.

dr-priority

DR election priority.

integer

Minimum value: 1 Maximum value: 4294967295

1

propagation-delay

Delay flooding packets on this interface.

integer

Minimum value: 100 Maximum value: 5000

500

state-refresh-interval

Interval between sending state-refresh packets.

integer

Minimum value: 1 Maximum value: 100

60

rp-candidate

Enable/disable compete to become RP in elections.

option

-

disable

Option

Description

enable

Compete for RP elections.

disable

Do not compete for RP elections.

rp-candidate-group

Multicast groups managed by this RP.

string

Maximum length: 35

rp-candidate-priority

Router's priority as RP.

integer

Minimum value: 0 Maximum value: 255

192

rp-candidate-interval

RP candidate advertisement interval.

integer

Minimum value: 1 Maximum value: 16383

60

multicast-flow

Acceptable source for multicast group.

string

Maximum length: 35

static-group

Statically set multicast groups to forward out.

string

Maximum length: 35

rpf-nbr-fail-back

Enable/disable fail back for RPF neighbor query.

option

-

disable

Option

Description

enable

Enable fail back for RPF neighbor query.

disable

Disable fail back for RPF neighbor query.

rpf-nbr-fail-back-filter

Filter for fail back RPF neighbors.

string

Maximum length: 35

config join-group

Parameter

Description

Type

Size

Default

address

Multicast group IP address.

ipv4-address-any

Not Specified

0.0.0.0

config igmp

Parameter

Description

Type

Size

Default

access-group

Groups IGMP hosts are allowed to join.

string

Maximum length: 35

version

Maximum version of IGMP to support.

option

-

3

Option

Description

3

Version 3 and lower.

2

Version 2 and lower.

1

Version 1.

immediate-leave-group

Groups to drop membership for immediately after receiving IGMPv2 leave.

string

Maximum length: 35

last-member-query-interval

Timeout between IGMPv2 leave and removing group.

integer

Minimum value: 1 Maximum value: 65535

1000

last-member-query-count

Number of group specific queries before removing group.

integer

Minimum value: 2 Maximum value: 7

2

query-max-response-time

Maximum time to wait for a IGMP query response.

integer

Minimum value: 1 Maximum value: 25

10

query-interval

Interval between queries to IGMP hosts.

integer

Minimum value: 1 Maximum value: 65535

125

query-timeout

Timeout between queries before becoming querying unit for network.

integer

Minimum value: 60 Maximum value: 900

255

router-alert-check

Enable/disable require IGMP packets contain router alert option.

option

-

disable

Option

Description

enable

Require Router Alert option in IGMP packets.

disable

don't require Router Alert option in IGMP packets

config pim-sm-global

Parameter

Description

Type

Size

Default

message-interval

Period of time between sending periodic PIM join/prune messages in seconds.

integer

Minimum value: 1 Maximum value: 65535

60

join-prune-holdtime

Join/prune holdtime.

integer

Minimum value: 1 Maximum value: 65535

210

accept-register-list

Sources allowed to register packets with this Rendezvous Point (RP).

string

Maximum length: 35

accept-source-list

Sources allowed to send multicast traffic.

string

Maximum length: 35

bsr-candidate

Enable/disable allowing this router to become a bootstrap router (BSR).

option

-

disable

Option

Description

enable

Allow this router to function as a BSR.

disable

Do not allow this router to function as a BSR.

bsr-interface

Interface to advertise as candidate BSR.

string

Maximum length: 15

bsr-priority

BSR priority.

integer

Minimum value: 0 Maximum value: 255

0

bsr-hash

BSR hash length.

integer

Minimum value: 0 Maximum value: 32

10

bsr-allow-quick-refresh

Enable/disable accept BSR quick refresh packets from neighbors.

option

-

disable

Option

Description

enable

Allow quick refresh packets.

disable

Do not allow quick refresh packets.

cisco-register-checksum

Checksum entire register packet(for old Cisco IOS compatibility).

option

-

disable

Option

Description

enable

register checksum entire packet.

disable

Do not register checksum entire packet.

cisco-register-checksum-group

Cisco register checksum only these groups.

string

Maximum length: 35

cisco-crp-prefix

Enable/disable making candidate RP compatible with old Cisco IOS.

option

-

disable

Option

Description

enable

Do not allow sending group prefix of zero.

disable

Allow sending group prefix of zero.

cisco-ignore-rp-set-priority

Use only hash for RP selection (compatibility with old Cisco IOS).

option

-

disable

Option

Description

enable

Ignore RP-SET priority value.

disable

Do not ignore RP-SET priority value.

register-rp-reachability

Enable/disable check RP is reachable before registering packets.

option

-

enable

Option

Description

enable

Check target RP is unicast reachable before registering.

disable

Do not check RP unicast reachability.

register-source

Override source address in register packets.

option

-

disable

Option

Description

disable

Use source address of RPF interface.

interface

Use primary IP of an interface.

ip-address

Use a local IP address.

register-source-interface

Override with primary interface address.

string

Maximum length: 15

register-source-ip

Override with local IP address.

ipv4-address

Not Specified

0.0.0.0

register-supression

Period of time to honor register-stop message.

integer

Minimum value: 1 Maximum value: 65535

60

null-register-retries

Maximum retries of null register.

integer

Minimum value: 1 Maximum value: 20

1

rp-register-keepalive

Timeout for RP receiving data on.

integer

Minimum value: 1 Maximum value: 65535

185

spt-threshold

Enable/disable switching to source specific trees.

option

-

enable

Option

Description

enable

Switch to Source tree when available.

disable

Do not switch to Source tree when available.

spt-threshold-group

Groups allowed to switch to source tree.

string

Maximum length: 35

ssm

Enable/disable source specific multicast.

option

-

disable

Option

Description

enable

Allow source specific multicast.

disable

Do not allow source specific multicast.

ssm-range

Groups allowed to source specific multicast.

string

Maximum length: 35

register-rate-limit

Limit of packets/sec per source registered through this RP.

integer

Minimum value: 0 Maximum value: 65535

0

pim-use-sdwan

Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.

option

-

disable

Option

Description

enable

Enable use of SDWAN when checking RPF neighbor and sending of REG packet.

disable

Disable use of SDWAN when checking RPF neighbor and sending of REG packet.

config rp-address

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

ip-address

RP router address.

ipv4-address

Not Specified

0.0.0.0

group

Groups to use this RP.

string

Maximum length: 35

config router multicast

Configure router multicast.

config router multicast
    Description: Configure router multicast.
    config interface
        Description: PIM interfaces.
        edit <name>
            set ttl-threshold {integer}
            set pim-mode [sparse-mode|dense-mode]
            set passive [enable|disable]
            set bfd [enable|disable]
            set neighbour-filter {string}
            set hello-interval {integer}
            set hello-holdtime {integer}
            set cisco-exclude-genid [enable|disable]
            set dr-priority {integer}
            set propagation-delay {integer}
            set state-refresh-interval {integer}
            set rp-candidate [enable|disable]
            set rp-candidate-group {string}
            set rp-candidate-priority {integer}
            set rp-candidate-interval {integer}
            set multicast-flow {string}
            set static-group {string}
            set rpf-nbr-fail-back [enable|disable]
            set rpf-nbr-fail-back-filter {string}
            config join-group
                Description: Join multicast groups.
                edit <address>
                next
            end
            config igmp
                Description: IGMP configuration options.
                set access-group {string}
                set version [3|2|...]
                set immediate-leave-group {string}
                set last-member-query-interval {integer}
                set last-member-query-count {integer}
                set query-max-response-time {integer}
                set query-interval {integer}
                set query-timeout {integer}
                set router-alert-check [enable|disable]
            end
        next
    end
    set multicast-routing [enable|disable]
    config pim-sm-global
        Description: PIM sparse-mode global settings.
        set message-interval {integer}
        set join-prune-holdtime {integer}
        set accept-register-list {string}
        set accept-source-list {string}
        set bsr-candidate [enable|disable]
        set bsr-interface {string}
        set bsr-priority {integer}
        set bsr-hash {integer}
        set bsr-allow-quick-refresh [enable|disable]
        set cisco-register-checksum [enable|disable]
        set cisco-register-checksum-group {string}
        set cisco-crp-prefix [enable|disable]
        set cisco-ignore-rp-set-priority [enable|disable]
        set register-rp-reachability [enable|disable]
        set register-source [disable|interface|...]
        set register-source-interface {string}
        set register-source-ip {ipv4-address}
        set register-supression {integer}
        set null-register-retries {integer}
        set rp-register-keepalive {integer}
        set spt-threshold [enable|disable]
        set spt-threshold-group {string}
        set ssm [enable|disable]
        set ssm-range {string}
        set register-rate-limit {integer}
        set pim-use-sdwan [enable|disable]
        config rp-address
            Description: Statically configure RP addresses.
            edit <id>
                set ip-address {ipv4-address}
                set group {string}
            next
        end
    end
    set route-limit {integer}
    set route-threshold {integer}
end

config router multicast

Parameter

Description

Type

Size

Default

multicast-routing

Enable/disable IP multicast routing.

option

-

disable

Option

Description

enable

Enable IP multicast routing.

disable

Disable IP multicast routing.

route-limit

Maximum number of multicast routes.

integer

Minimum value: 1 Maximum value: 2147483647

2147483647

route-threshold

Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.

integer

Minimum value: 1 Maximum value: 2147483647

config interface

Parameter

Description

Type

Size

Default

name

Interface name.

string

Maximum length: 15

ttl-threshold

Minimum TTL of multicast packets that will be forwarded.

integer

Minimum value: 1 Maximum value: 255

1

pim-mode

PIM operation mode.

option

-

sparse-mode

Option

Description

sparse-mode

sparse-mode

dense-mode

dense-mode

passive

Enable/disable listening to IGMP but not participating in PIM.

option

-

disable

Option

Description

enable

Listen only.

disable

Participate in PIM.

bfd

Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

option

-

disable

Option

Description

enable

Enable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

disable

Disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).

neighbour-filter

Routers acknowledged as neighbor routers.

string

Maximum length: 35

hello-interval

Interval between sending PIM hello messages.

integer

Minimum value: 1 Maximum value: 65535

30

hello-holdtime

Time before old neighbor information expires.

integer

Minimum value: 1 Maximum value: 65535

cisco-exclude-genid

Exclude GenID from hello packets (compatibility with old Cisco IOS).

option

-

disable

Option

Description

enable

Do not send GenID.

disable

Send GenID according to standard.

dr-priority

DR election priority.

integer

Minimum value: 1 Maximum value: 4294967295

1

propagation-delay

Delay flooding packets on this interface.

integer

Minimum value: 100 Maximum value: 5000

500

state-refresh-interval

Interval between sending state-refresh packets.

integer

Minimum value: 1 Maximum value: 100

60

rp-candidate

Enable/disable compete to become RP in elections.

option

-

disable

Option

Description

enable

Compete for RP elections.

disable

Do not compete for RP elections.

rp-candidate-group

Multicast groups managed by this RP.

string

Maximum length: 35

rp-candidate-priority

Router's priority as RP.

integer

Minimum value: 0 Maximum value: 255

192

rp-candidate-interval

RP candidate advertisement interval.

integer

Minimum value: 1 Maximum value: 16383

60

multicast-flow

Acceptable source for multicast group.

string

Maximum length: 35

static-group

Statically set multicast groups to forward out.

string

Maximum length: 35

rpf-nbr-fail-back

Enable/disable fail back for RPF neighbor query.

option

-

disable

Option

Description

enable

Enable fail back for RPF neighbor query.

disable

Disable fail back for RPF neighbor query.

rpf-nbr-fail-back-filter

Filter for fail back RPF neighbors.

string

Maximum length: 35

config join-group

Parameter

Description

Type

Size

Default

address

Multicast group IP address.

ipv4-address-any

Not Specified

0.0.0.0

config igmp

Parameter

Description

Type

Size

Default

access-group

Groups IGMP hosts are allowed to join.

string

Maximum length: 35

version

Maximum version of IGMP to support.

option

-

3

Option

Description

3

Version 3 and lower.

2

Version 2 and lower.

1

Version 1.

immediate-leave-group

Groups to drop membership for immediately after receiving IGMPv2 leave.

string

Maximum length: 35

last-member-query-interval

Timeout between IGMPv2 leave and removing group.

integer

Minimum value: 1 Maximum value: 65535

1000

last-member-query-count

Number of group specific queries before removing group.

integer

Minimum value: 2 Maximum value: 7

2

query-max-response-time

Maximum time to wait for a IGMP query response.

integer

Minimum value: 1 Maximum value: 25

10

query-interval

Interval between queries to IGMP hosts.

integer

Minimum value: 1 Maximum value: 65535

125

query-timeout

Timeout between queries before becoming querying unit for network.

integer

Minimum value: 60 Maximum value: 900

255

router-alert-check

Enable/disable require IGMP packets contain router alert option.

option

-

disable

Option

Description

enable

Require Router Alert option in IGMP packets.

disable

don't require Router Alert option in IGMP packets

config pim-sm-global

Parameter

Description

Type

Size

Default

message-interval

Period of time between sending periodic PIM join/prune messages in seconds.

integer

Minimum value: 1 Maximum value: 65535

60

join-prune-holdtime

Join/prune holdtime.

integer

Minimum value: 1 Maximum value: 65535

210

accept-register-list

Sources allowed to register packets with this Rendezvous Point (RP).

string

Maximum length: 35

accept-source-list

Sources allowed to send multicast traffic.

string

Maximum length: 35

bsr-candidate

Enable/disable allowing this router to become a bootstrap router (BSR).

option

-

disable

Option

Description

enable

Allow this router to function as a BSR.

disable

Do not allow this router to function as a BSR.

bsr-interface

Interface to advertise as candidate BSR.

string

Maximum length: 15

bsr-priority

BSR priority.

integer

Minimum value: 0 Maximum value: 255

0

bsr-hash

BSR hash length.

integer

Minimum value: 0 Maximum value: 32

10

bsr-allow-quick-refresh

Enable/disable accept BSR quick refresh packets from neighbors.

option

-

disable

Option

Description

enable

Allow quick refresh packets.

disable

Do not allow quick refresh packets.

cisco-register-checksum

Checksum entire register packet(for old Cisco IOS compatibility).

option

-

disable

Option

Description

enable

register checksum entire packet.

disable

Do not register checksum entire packet.

cisco-register-checksum-group

Cisco register checksum only these groups.

string

Maximum length: 35

cisco-crp-prefix

Enable/disable making candidate RP compatible with old Cisco IOS.

option

-

disable

Option

Description

enable

Do not allow sending group prefix of zero.

disable

Allow sending group prefix of zero.

cisco-ignore-rp-set-priority

Use only hash for RP selection (compatibility with old Cisco IOS).

option

-

disable

Option

Description

enable

Ignore RP-SET priority value.

disable

Do not ignore RP-SET priority value.

register-rp-reachability

Enable/disable check RP is reachable before registering packets.

option

-

enable

Option

Description

enable

Check target RP is unicast reachable before registering.

disable

Do not check RP unicast reachability.

register-source

Override source address in register packets.

option

-

disable

Option

Description

disable

Use source address of RPF interface.

interface

Use primary IP of an interface.

ip-address

Use a local IP address.

register-source-interface

Override with primary interface address.

string

Maximum length: 15

register-source-ip

Override with local IP address.

ipv4-address

Not Specified

0.0.0.0

register-supression

Period of time to honor register-stop message.

integer

Minimum value: 1 Maximum value: 65535

60

null-register-retries

Maximum retries of null register.

integer

Minimum value: 1 Maximum value: 20

1

rp-register-keepalive

Timeout for RP receiving data on.

integer

Minimum value: 1 Maximum value: 65535

185

spt-threshold

Enable/disable switching to source specific trees.

option

-

enable

Option

Description

enable

Switch to Source tree when available.

disable

Do not switch to Source tree when available.

spt-threshold-group

Groups allowed to switch to source tree.

string

Maximum length: 35

ssm

Enable/disable source specific multicast.

option

-

disable

Option

Description

enable

Allow source specific multicast.

disable

Do not allow source specific multicast.

ssm-range

Groups allowed to source specific multicast.

string

Maximum length: 35

register-rate-limit

Limit of packets/sec per source registered through this RP.

integer

Minimum value: 0 Maximum value: 65535

0

pim-use-sdwan

Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.

option

-

disable

Option

Description

enable

Enable use of SDWAN when checking RPF neighbor and sending of REG packet.

disable

Disable use of SDWAN when checking RPF neighbor and sending of REG packet.

config rp-address

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

ip-address

RP router address.

ipv4-address

Not Specified

0.0.0.0

group

Groups to use this RP.

string

Maximum length: 35