xref: /freebsd/sbin/pflowctl/pflowctl.8 (revision 78ae60b447ebf420dd5cebfec30480866fd5cef4)
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 08 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 lc
28.Op Fl d Ar id
29.Op Fl s Ar id ...
30.Ek
31.Sh DESCRIPTION
32The
33.Nm
34utility creates, configures and deletes netflow accounting data export using the
35.Xr pflow 4
36subsystem.
37.Pp
38The
39.Nm
40utility provides several commands.
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl c
44Create a new
45.Xr pflow 4
46exporter.
47.It Fl d Ar id
48Remove an existing
49.Xr pflow 4
50exporter.
51The
52.Ar id
53may be either numeric or the full pflowX name.
54.It Fl l
55List all existing
56.Xr pflow 4
57exporters.
58.It Fl s Ar id ...
59Configure an existing
60.Xr pflow 4
61exporter.
62This takes the following keywords:
63.Pp
64.Bl -tag -width xxxxxxxxxxxx -compact
65.It Cm src
66set the source IP address (and optionally port).
67.It Cm dst
68set the destination IP address (and optionally port).
69.It Cm proto
70set the protocol version.
71Valid values are 5 and 10.
72.It Cm domain
73set the observation domain.
74.El
75.Pp
76Multiple keywords may be passed in the same command invocation.
77.Pp
78For example, the following command sets 10.0.0.1 as the source
79and 10.0.0.2:1234 as destination:
80.Bd -literal -offset indent
81# pflowctl -s pflow0 src 10.0.0.1 dst 10.0.0.2:1234
82.Ed
83.Sh SEE ALSO
84.Xr netintro 4 ,
85.Xr pf 4 ,
86.Xr pflow 4 ,
87.Xr udp 4 ,
88.Xr pf.conf 5
89.Sh HISTORY
90The
91.Nm
92command first appeared in
93.Fx 15.0 .
94