xref: /illumos-gate/usr/src/man/man8/ipfs.8 (revision bbf21555)
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.
IPFS 8 "Oct 30, 2013"
NAME
ipfs - saves and restores information for NAT and state tables
SYNOPSIS

ipfs [-G | -z zonename] [-nv] -l

ipfs [-G | -z zonename] [-nv] -u

ipfs [-G | -z zonename] [-nv] [-d dirname] -R

ipfs [-G | -z zonename] [-nv] [-d dirname] -W

ipfs [-G | -z zonename] [-nNSv] [-f filename] -r

ipfs [-G | -z zonename] [-nNSv] [-f filename] -w

ipfs [-G | -z zonename] [-nNSv] -f filename -i <if1>,<if2>
DESCRIPTION

The ipfs utility enables the saving of state information across reboots. Specifically, the utility allows state information created for NAT entries and rules using "keep state" to be locked (modification prevented) and then saved to disk. Then, after a reboot, that information is restored. The result of this state-saving is that connections are not interrupted.

OPTIONS

The following options are supported: -d

Change the default directory used with -R and -W options for saving state information.

-n

Do not take any action that would affect information stored in the kernel or on disk.

-v

Provides a verbose description of ipfs activities.

-N

Operate on NAT information.

-S

Operate on filtering state information.

-u

Unlock state tables in the kernel.

-l

Lock state tables in the kernel.

-r

Read information in from the specified file and load it into the kernel. This requires the state tables to have already been locked and does not change the lock once complete.

-w

Write information out to the specified file and from the kernel. This requires the state tables to have already been locked and does not change the lock once complete.

-R

Restores all saved state information, if any, from two files, ipstate.ipf and ipnat.ipf, stored in the /var/db/ipf directory. This directory can be changed with the -d option. The state tables are locked at the beginning of this operation and unlocked once complete.

-W

Saves in-kernel state information, if any, out to two files, ipstate.ipf and ipnat.ipf, stored in the /var/db/ipf directory. This directory can be changed with the -d option. The state tables are locked at the beginning of this operation and unlocked once complete.

-z zonename

Operate on the in-zone state information 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 state information 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/ipl

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO

attributes (7), zones (7), ipf (8), ipmon (8), ipnat (8)

DIAGNOSTICS

Arguably, the -W and -R operations should set the locking and, rather than undo it, restore it to what it was previously.

Fragment table information is currently not saved.