PIMCTL(8) (smm)
PIMCTL(8) System Manager's Manual (smm) PIMCTL(8)

NAME

pimctlControl tool for pimd(8)

SYNOPSIS

pimctl [-pth] [-i NAME] [COMMAND]

pimctl help | kill | restart | version

pimctl debug [? | none | SYSTEM [,SYSTEM]]

pimctl log [? | none | LEVEL]

pimctl show igmp groups

pimctl show igmp interface

pimctl show pim interface

pimctl show pim neighbor

pimctl show pim routes [detail]

pimctl show pim rp

pimctl show pim crp

pimctl show pim compat [detail]

pimctl [show status]

DESCRIPTION

pimctl is the friendly control tool for pimd(8). It can be used to query status, debug, restart, and kill a running pimd. Commands can be abbreviated to the minimum unambiguous prefix; for example, s s for show status.

OPTIONS

This program follows the usual UNIX command line syntax, with long options starting with two dashes (`-'). The options are as follows:
-h, --help
Show usage instructions and exit.
-i, --ident NAME
Connect to named pimd instance.
-p, --plain
Use plain table headings, no ANSI ctrl characters.
-t, --no-heading
Skip table headings altogether.

COMMANDS

The following commands are available:
pimctl help
Show usage instructions and exit.
pimctl kill
Kill running daemon, like sending SIGTERM to pimd(8)
pimctl debug [? | none | SYSTEM [,SYSTEM]]
Control subystem debugging at runtime. Multiple subsystems can be enabled, separate with comma. E.g.
pimctl debug igmp,pim
    
The command returns a list of enabled subsystems. Without any debug argument, the command lists the currently enabled subsystems. To list all available subsystems, use
pimctl debug ?
    
To disable all subsystems, use
pimctl debug none
    
Subsystems:
packet
Debug inbound/outbout packets
prunes
Pruning operations, or pruned routes
routes
Routing messages
rtdetail
Detailed routing information
peers
Neighbor gossip
cache
Debug routing cache
timeout
Debug timeouts
interface
Show interface (VIF) debug messages
groups
Debug group memberships
mtrace
Multicast traceroute information
igmp
Debug IGMP messages
icmp
Debug ICMP messages
rsrr
Debug RSRR messages
pim
All PIM messages
pim_routes
PIM routing messages
pim_bsr
PIM bootstrap router messages
pim_detail
Detailed PIM debug
pim_hello
Debug hello messages to/from neighbors
all
Enable all subsystems (may trigger log rate limiter)
pimctl log [? | none | LEVEL]
Control, query, or disable pimd(8) log level:
none
Disable all logging
error
Error conditions
warning
Warning conditions
notice
Normal but significant condition (Default)
info
Informational
debug
Debug-level messages
pimctl restart
Restart daemon and reload /etc/pimd.conf, like sending SIGHUP to pimd(8)
pimctl show igmp groups
Show IGMP group memberships
pimctl show igmp interfaces
Show IGMP interface status
pimctl show pim interfaces
Show PIM interface table
pimctl show pim neighbor
Show PIM neighbor table
pimctl show pim routes
Show PIM routing table
pimctl show pim rp
Show PIM Rendezvous-Point (RP) set
pimctl show pim crp
Show PIM Candidate Rendezvous-Point (CRP) from BSR
pimctl show pim compat
Show PIM status, compat mode. Previously available as pimd -r, as well as sending pimd(8) SIGUSR1 to get output in /var/run/pimd/pimd.dump
pimctl [show status]
Show pimd(8) status, default

FILES

/var/run/pimd.sock
UNIX-domain socket used for communication with pimd(8)
Note, the basename used changes when running with a different identity, -i NAME

SEE ALSO

pimd(8), /usr/share/doc/pimd/

AUTHORS

pimd was originally written by Ahmed Helmy, George Edmond "Rusty" Eddy, and Pavlin Ivanov Radoslavov. PIM-SSM, including full IGMPv3 support, was added by Markus Veranen. With contributions by many others.
pimctl was written by Joachim Wiberg.
January 2, 2019 Debian