pfSense

First target is FRR: #14588

To use this, packages need to make two changes:

First define the plugin in their main XML file (e.g. frr.xml)

    <plugins>
        <item>
            <type>plugin_statusoutput</type>
        </item>
    </plugins>

If there are existing plugins, add the new one as an additional item:

    <plugins>
        <item>
            <type>plugin_carp</type>
        </item>
        <item>
            <type>plugin_statusoutput</type>
        </item>
    </plugins>

Next, add a new function named <packagename>_plugin_statusoutput() which defines commands and/or log files to include. For example:

function frr_plugin_statusoutput($pluginparams) {
    require_once('status_output.inc');
    $entry_prefix = 'Package-FRR-';
    if (is_readable('/var/etc/frr/frr.conf')) {
        status_cmd_define("{$entry_prefix}Config-FRR", "cat /var/etc/frr/frr.conf");
    }
    if ($frr_enabled) {
        status_cmd_define("{$entry_prefix}Config-running", "/usr/local/bin/vtysh -c 'show run'");
    }
}

This looks wonderful. Thank you.

My only concern would be showing the full BGP route table. But since we're already including the kernel FIB and state table, etc, it should be OK. If they are running full tables they should be on hardware that can handle the show command.

Chris Linstruth wrote in #note-7:

This looks wonderful. Thank you.

My only concern would be showing the full BGP route table. But since we're already including the kernel FIB and state table, etc, it should be OK. If they are running full tables they should be on hardware that can handle the show command.

I was wondering about that as well. I suppose it could try to check the output of something like show ip route summ and skip certain commands if there are more than X number of entries. We can address that in the future if it becomes a problem.