xref: /freebsd/sbin/pflowctl/pflowctl.8 (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1.\" $OpenBSD: pflow.4,v 1.19 2014/03/29 11:26:03 florian Exp $
2.\"
3.\" Copyright (c) 2008 Henning Brauer <henning@openbsd.org>
4.\" Copyright (c) 2008 Joerg Goltermann <jg@osn.de>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: January 25 2024 $
19.Dt PFLOWCTL 8
20.Os
21.Sh NAME
22.Nm pflowctl
23.Nd control pflow data export
24.Sh SYNOPSIS
25.Nm pflowctl
26.Bk -words
27.Op Fl v
28.Op Fl lc
29.Op Fl d Ar id
30.Op Fl s Ar id ...
31.Ek
32.Sh DESCRIPTION
33The
34.Nm
35utility creates, configures and deletes netflow accounting data export using the
36.Xr pflow 4
37subsystem.
38.Pp
39The
40.Nm
41utility provides several commands.
42The options are as follows:
43.Bl -tag -width Ds
44.It Fl v
45Produce verbose output.
46.It Fl c
47Create a new
48.Xr pflow 4
49exporter.
50.It Fl d Ar id
51Remove an existing
52.Xr pflow 4
53exporter.
54The
55.Ar id
56may be either numeric or the full pflowX name.
57.It Fl l
58List all existing
59.Xr pflow 4
60exporters.
61.It Fl s Ar id ...
62Configure an existing
63.Xr pflow 4
64exporter.
65This takes the following keywords:
66.Pp
67.Bl -tag -width xxxxxxxxxxxx -compact
68.It Cm src
69set the source IP address (and optionally port).
70.It Cm dst
71set the destination IP address (and optionally port).
72.It Cm proto
73set the protocol version.
74Valid values are 5 and 10.
75.It Cm domain
76set the observation domain.
77.El
78.Pp
79Multiple keywords may be passed in the same command invocation.
80.Pp
81For example, the following command sets 10.0.0.1 as the source
82and 10.0.0.2:1234 as destination:
83.Bd -literal -offset indent
84# pflowctl -s pflow0 src 10.0.0.1 dst 10.0.0.2:1234
85.Ed
86.Sh SEE ALSO
87.Xr netintro 4 ,
88.Xr pf 4 ,
89.Xr pflow 4 ,
90.Xr udp 4 ,
91.Xr pf.conf 5
92.Sh HISTORY
93The
94.Nm
95command first appeared in
96.Fx 15.0 .
97