xref: /illumos-gate/usr/src/man/man8/ipnat.8 (revision d48be21240dfd051b689384ce2b23479d757f2d8)
te
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
location.
Portions Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
Portions Copyright (c) 2013, Joyent, Inc. All Rights Reserved.
IPNAT 8 "Oct 30, 2013"
NAME
ipnat - user interface to the NAT subsystem
SYNOPSIS

ipnat [-CdFhlnRrsv] [-G | -z zonename] -f filename
DESCRIPTION

The ipnat utility opens a specified file (treating - as stdin) and parses it for a set of rules that are to be added or removed from the IP NAT.

If there are no parsing problems, each rule processed by ipnat is added to the kernel's internal lists. Rules are appended to the internal lists, matching the order in which they appear when given to ipnat.

ipnat's use is restricted through access to /dev/ipauth, /dev/ipl, and /dev/ipstate. The default permissions of these files require ipnat to be run as root for all operations.

ipnat's use is restricted through access to /dev/ipnat. The default permissions of /dev/ipnat require ipnat to be run as root for all operations.

OPTIONS

The following options are supported: -C

Delete all entries in the current NAT rule listing (NAT rules).

-d

Turn debug mode on. Causes a hex dump of filter rules to be generated as it processes each one.

-F

Delete all active entries in the current NAT translation table (currently active NAT mappings).

-f filename

Parse specified file for rules to be added or removed from the IP NAT. filename can be stdin.

-h

Print number of hits for each MAP/Redirect filter.

-l

Show the list of current NAT table entry mappings.

-n

Prevents ipf from doing anything, such as making ioctl calls, which might alter the currently running kernel.

-R

Disable both IP address-to-hostname resolution and port number-to-service name resolution.

-r

Remove matching NAT rules rather than add them to the internal lists.

-s

Retrieve and display NAT statistics.

-v

Turn verbose mode on. Displays information relating to rule processing and active rules/table entries.

-z zonename

Operate on the in-zone IP NAT for the specified zone. If neither this option nor -G is specified, the current zone is used. This command is only available in the Global Zone. See ZONES in ipf(8) for more information.

-G zonename

Operate on the global zone controlled IP NAT for the specified zone. If neither this option nor -z is specified, the current zone is used. This command is only available in the Global Zone. See ZONES in ipf(8) for more information.

FILES
/dev/ipnat

Link to IP Filter pseudo device.

/dev/kmem

Special file that provides access to virtual address space.

/etc/ipf/ipnat.conf

Location of ipnat startup configuration file.

/usr/share/ipfilter/examples/

Contains numerous IP Filter examples.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO

ipnat (5), attributes (7), zones (7), ipf (8), ipfstat (8)