config igmp

  • Published on Jan 21, 2025
  • 3 minute(s) read
  • jM
 Prev Next

Commands for inspecting and changing the host systems’s Internet Group Management Protocol (IGMP) configuration.

show igmp status

Describes the host system’s current IGMP configuration.

show igmp status

Example output:

[Thu Dec 19 05:53:09 2024] > show igmp status
[Thu Dec 19 05:53:09 2024] Interval: 30000000000 ns
[Thu Dec 19 05:53:09 2024] #        Group            Port   VLAN   VLAN IP
[Thu Dec 19 05:53:09 2024] -----------------------------------------------------
[Thu Dec 19 05:53:09 2024] 0
[Thu Dec 19 05:53:09 2024]  |-> 1   224.0.50.0       17107  none   none
[Thu Dec 19 05:53:09 2024]  |-> 2   224.0.114.34     17107  none   192.168.124.1
[Thu Dec 19 05:53:09 2024]  |-> 3   224.0.114.36     17107  none   192.168.124.1
[Thu Dec 19 05:53:09 2024]  |-> 4   224.0.114.38     17107  none   192.168.124.1
[Thu Dec 19 05:53:09 2024] 1
[Thu Dec 19 05:53:09 2024] -----------------------------------------------------

This command supports JSON output when run from the shell:

fmadio@fmadio20v3-508:/mnt/store0/develop$ fmadiocli --json "show igmp status"
fmad fmadlua Dec 18 2024 (/opt/fmadio/bin/fmadiolua --nocal /opt/fmadio/bin/fmadiocli --json show igmp status )
Disable cycle calibration
[Thu Dec 19 05:53:30 2024] CmdLine [--json]
[Thu Dec 19 05:53:30 2024] JSON [show igmp status]
{"IsJSON":true,"Interval":30000000000,"MulticastGroups":[[{"Group":"224.0.50.0","Port":17107,"VLAN":null,"VLANIP":null},{"Group":"224.0.114.34","Port":17107,"VLAN":null,"VLANIP":"192.168.124.1"},{"Group":"224.0.114.36","Port":17107,"VLAN":null,"VLANIP":"192.168.124.1"},{"Group":"224.0.114.38","Port":17107,"VLAN":null,"VLANIP":"192.168.124.1"}],[]],"done":true}

config igmp interval

Sets the IGMP multicast join interval in nanoseconds.

config igmp interval <nanoseconds>

Example output:

[Fri Dec 20 04:55:23 2024] > config igmp interval 30000000000
[Fri Dec 20 04:55:23 2024] /opt/fmadio/etc/igmp.lua updated successfully.
[Fri Dec 20 04:55:30 2024] > config igmp interval 60e9
[Fri Dec 20 04:55:31 2024] /opt/fmadio/etc/igmp.lua updated successfully.

config igmp add

Adds a new IGMP multicast rule, optionally with a port number and/or VLAN ID.

config igmp add <capture port> <multicast address> [port number] [VLAN ID]

Example output:

[Fri Dec 20 04:11:18 2024] > config igmp add 0 192.168.19.70
[Fri Dec 20 04:11:18 2024] /opt/fmadio/etc/igmp.lua updated successfully.
[Fri Dec 20 04:11:45 2024] > config igmp add 0 192.168.19.71 12300
[Fri Dec 20 04:12:10 2024] /opt/fmadio/etc/igmp.lua updated successfully.
[Fri Dec 20 04:12:16 2024] > config igmp add 0 192.168.19.72 12301 999
[Fri Dec 20 04:12:17 2024] /opt/fmadio/etc/igmp.lua updated successfully.

config igmp del

Deletes an IGMP multicast rule.

config igmp del <capture port> <multicast address>

Example output:

[Fri Dec 20 04:35:29 2024] > config igmp del 0 192.168.19.70
[Fri Dec 20 04:35:29 2024] /opt/fmadio/etc/igmp.lua updated successfully.

config igmp enable

Enables an IGMP multicast rule.

config igmp enable <capture port> <multicast address>

Example output:

[Fri Dec 20 04:39:16 2024] > config igmp enable 0 224.0.50.0
[Fri Dec 20 04:39:16 2024] /opt/fmadio/etc/igmp.lua updated successfully.
[Fri Dec 20 04:39:16 2024] > config igmp enable 0 224.0.50.0
[Fri Dec 20 04:39:17 2024] Rule 0 224.0.50.0 is already enabled; no changes made

config igmp disable

Disables an IGMP multicast rule.

config igmp disable <capture port> <multicast address>

Example output:

[Fri Dec 20 04:38:45 2024] > config igmp disable 0 224.0.50.0
[Fri Dec 20 04:38:45 2024] /opt/fmadio/etc/igmp.lua updated successfully.
[Fri Dec 20 04:38:49 2024] > config igmp disable 0 224.0.50.0
[Fri Dec 20 04:38:49 2024] Rule 0 224.0.50.0 is already disabled; no changes made

show igmp comment

FMADIO systems support attaching arbitrary strings to IGMP multicast rules to act as internal documentation. This command shows what comment has been attached to any given rule.

show igmp comment <capture port> <multicast address>

Example output:

[Fri Dec 20 05:06:10 2024] > show igmp comment 0 224.0.50.0
[Fri Dec 20 05:06:10 2024] <multicast rule has no comment>
[Fri Dec 20 05:06:38 2024] > show igmp comment 0 224.0.114.34
[Fri Dec 20 05:06:39 2024] hello world

This command supports JSON output when run from the shell:

fmadio@fmadio20v3-508:/mnt/store0/develop$ fmadiocli --json "show igmp comment 0 224.0.50.0"
fmad fmadlua Dec 20 2024 (/opt/fmadio/bin/fmadiolua --nocal /opt/fmadio/bin/fmadiocli --json show igmp comment 0 224.0.50.0 )
Disable cycle calibration
[Fri Dec 20 05:05:21 2024] CmdLine [--json]
[Fri Dec 20 05:05:21 2024] JSON [show igmp comment 0 224.0.50.0]
{"Comment":"%s"}        <multicast rule has no comment>

config igmp comment

FMADIO systems support attaching arbitrary strings to IGMP multicast rules to act as internal documentation. This command changes the comment for a rule.

config igmp comment <capture port> <multicast address> <comment>

Example output:

[Sat Dec 21 01:12:56 2024] > config igmp comment 0 224.0.114.34 "hello world"
[Sat Dec 21 01:12:57 2024] /opt/fmadio/etc/igmp.lua updated successfully.

config igmp reload

Deletes and re-generates /opt/fmadio/etc/igmp.lua from a template. Beware that there is no way to recover the deleted file once this command is run.

config igmp reload

Example output:

[Thu Dec 19 05:56:45 2024] > config igmp reload
local cmd [rm /opt/fmadio/etc/igmp.lua 2> /dev/null]
[Thu Dec 19 05:56:45 2024] /opt/fmadio/etc/igmp.lua updated successfully.