usr/src/man/man1m/ipnat.1m

   1 '\" te
   2 .\" To view license terms, attribution, and copyright for IP Filter, the default path is /usr/lib/ipf/IPFILTER.LICENCE. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the installed
   3 .\" location.
   4 .\" Portions Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   5 .\" Portions Copyright (c) 2013, Joyent, Inc. All Rights Reserved.
   6 .TH IPNAT 1M "Oct 30, 2013"
   7 .SH NAME
   8 ipnat \- user interface to the NAT subsystem
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBipnat\fR [\fB-CdFhlnRrsv\fR] [\fB-G\fR | \fB-z\fR \fIzonename\fR] \fB-f\fR \fIfilename\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The \fBipnat\fR utility opens a specified file (treating \fB-\fR as stdin) and
  18 parses it for a set of rules that are to be added or removed from the IP NAT.
  19 .sp
  20 .LP
  21 If there are no parsing problems, each rule processed by \fBipnat\fR is added
  22 to the kernel's internal lists. Rules are appended to the internal lists,
  23 matching the order in which they appear when given to \fBipnat\fR.
  24 .sp
  25 .LP
  26 \fBipnat\fR's use is restricted through access to \fB/dev/ipauth\fR,
  27 \fB/dev/ipl\fR, and \fB/dev/ipstate\fR. The default permissions of these files
  28 require \fBipnat\fR to be run as root for all operations.
  29 .sp
  30 .LP
  31 \fBipnat\fR's use is restricted through access to \fB/dev/ipnat\fR. The default
  32 permissions of \fB/dev/ipnat\fR require \fBipnat\fR to be run as root for all
  33 operations.
  34 .SH OPTIONS
  35 .LP
  36 The following options are supported:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fB-C\fR\fR
  41 .ad
  42 .RS 15n
  43 Delete all entries in the current NAT rule listing (NAT rules).
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fB-d\fR\fR
  50 .ad
  51 .RS 15n
  52 Turn debug mode on. Causes a hex dump of filter rules to be generated as it
  53 processes each one.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-F\fR\fR
  60 .ad
  61 .RS 15n
  62 Delete all active entries in the current NAT translation table (currently
  63 active NAT mappings).
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-f\fR \fIfilename\fR\fR
  70 .ad
  71 .RS 15n
  72 Parse specified file for rules to be added or removed from the IP NAT.
  73 \fIfilename\fR can be stdin.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-h\fR\fR
  80 .ad
  81 .RS 15n
  82 Print number of hits for each MAP/Redirect filter.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB-l\fR\fR
  89 .ad
  90 .RS 15n
  91 Show the list of current NAT table entry mappings.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-n\fR\fR
  98 .ad
  99 .RS 15n
 100 Prevents \fBipf\fR from doing anything, such as making ioctl calls, which might
 101 alter the currently running kernel.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-R\fR\fR
 108 .ad
 109 .RS 15n
 110 Disable both IP address-to-hostname resolution and port number-to-service name
 111 resolution.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB-r\fR\fR
 118 .ad
 119 .RS 15n
 120 Remove matching NAT rules rather than add them to the internal lists.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fB-s\fR\fR
 127 .ad
 128 .RS 15n
 129 Retrieve and display NAT statistics.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB-v\fR\fR
 136 .ad
 137 .RS 15n
 138 Turn verbose mode on. Displays information relating to rule processing and
 139 active rules/table entries.
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB-z\fR \fIzonename\fR\fR
 146 .ad
 147 .RS 15n
 148 Operate on the in-zone IP NAT for the specified zone. If neither this option
 149 nor \fB-G\fR is specified, the current zone is used. This command is only
 150 available in the Global Zone. See \fBZONES\fR in \fBipf\fR(1m) for more
 151 information.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB-G\fR \fIzonename\fR\fR
 158 .ad
 159 .RS 15n
 160 Operate on the global zone controlled IP NAT for the specified zone. If
 161 neither this option nor \fB-z\fR is specified, the current zone is used. This
 162 command is only available in the Global Zone. See \fBZONES\fR in \fBipf\fR(1m)
 163 for more information.
 164 .RE
 165
 166 .SH FILES
 167 .ne 2
 168 .na
 169 \fB\fB/dev/ipnat\fR\fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 Link to IP Filter pseudo device.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB/dev/kmem\fR\fR
 180 .ad
 181 .sp .6
 182 .RS 4n
 183 Special file that provides access to virtual address space.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fB\fB/etc/ipf/ipnat.conf\fR\fR
 190 .ad
 191 .sp .6
 192 .RS 4n
 193 Location of \fBipnat\fR startup configuration file.
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fB/usr/share/ipfilter/examples/\fR\fR
 200 .ad
 201 .sp .6
 202 .RS 4n
 203 Contains numerous IP Filter examples.
 204 .RE
 205
 206 .SH ATTRIBUTES
 207 .LP
 208 See \fBattributes\fR(5) for descriptions of the following attributes:
 209 .sp
 210
 211 .sp
 212 .TS
 213 box;
 214 c | c
 215 l | l .
 216 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 217 _
 218 Interface Stability     Committed
 219 .TE
 220
 221 .SH SEE ALSO
 222 .LP
 223 \fBipf\fR(1M), \fBipfstat\fR(1M), \fBipnat\fR(4), \fBattributes\fR(5),
 224 \fBzones(5)\fR