share/man/man4/ipmon.4

   1 '\" te
   2 .\" To view license terms, attribution, and copyright for IP Filter, the
   3 .\" default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Illumos operating
   4 .\" environment has been installed anywhere other than the default, modify the
   5 .\" given path to access the file at the installed location.
   6 .\" Portions Copyright (c) 2015, Joyent, Inc.
   7 .TH IPMON 4 "Mar 18, 2015"
   8 .SH NAME
   9 ipmon, ipmon.conf \- ipmon configuration file format
  10 .SH DESCRIPTION
  11 The format for files accepted by ipmon is described by the following grammar:
  12 .LP
  13 .nf
  14 "match" "{" matchlist "}" "do" "{" doing "}" ";"
  15
  16 matchlist ::= matching [ "," matching ] .
  17 matching  ::= direction | dstip | dstport | every | group | interface |
  18               logtag | nattag | protocol | result | rule | srcip | srcport .
  19
  20 dolist ::= doing [ "," doing ] .
  21 doing  ::= execute | save | syslog .
  22
  23 direction ::= "in" | "out" .
  24 dstip     ::= "dstip" "=" ipv4 "/" number .
  25 dstport   ::= "dstport" "=" number .
  26 every     ::= "every" every-options .
  27 execute   ::= "execute" "=" string .
  28 group     ::= "group" "=" string | "group" "=" number .
  29 interface ::= "interface" "=" string .
  30 logtag    ::= "logtag" "=" string | "logtag" "=" number .
  31 nattag    ::= "nattag" "=" string .
  32 protocol  ::= "protocol" "=" string | "protocol" "=" number .
  33 result    ::= "result" "=" result-option .
  34 rule      ::= "rule" "=" number .
  35 srcip     ::= "srcip" "=" ipv4 "/" number .
  36 srcport   ::= "srcport" "=" number .
  37 type      ::= "type" "=" ipftype .
  38 ipv4      ::= number "." number "." number "." number .
  39
  40 every-options ::= "second" | number "seconds" | "packet" | number "packets" .
  41 result-option ::= "pass" | "block" | "short" | "nomatch" | "log" .
  42 ipftype ::= "ipf" | "nat" | "state" .
  43
  44 .fi
  45 .PP
  46 In addition, lines that start with a # are considered to be comments.
  47 .SH OVERVIEW
  48 .PP
  49 The ipmon configuration file is used for defining rules to be executed when
  50 logging records are read from
  51 .B /dev/ipl.
  52 .PP
  53 At present, only IPv4 matching is available for source/destination address
  54 matching.
  55 .SH MATCHING
  56 .PP
  57 Each rule for ipmon consists of two primary segments: the first describes how
  58 the log record is to be matched, the second defines what action to take if
  59 there is a positive match.  All entries of the rules present in the file are
  60 compared for matches - there is no first or last rule match.
  61 .SH FILES
  62 /dev/ipl
  63 .br
  64 /dev/ipf
  65 .br
  66 /dev/ipnat
  67 .br
  68 /dev/ipstate
  69 .br
  70 /etc/ipmon.conf
  71 .SH SEE ALSO
  72 \fBipmon\fR(8), \fBipfilter\fR(5)