xref: /freebsd/usr.sbin/ip6addrctl/ip6addrctl.8 (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
1.\"	$KAME: ip6addrctl.8,v 1.3 2003/03/22 05:56:41 jinmei Exp $
2.\"
3.\" Copyright (C) 2001 WIDE Project.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the project nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd August 10, 2024
31.Dt IP6ADDRCTL 8
32.Os
33.\"
34.Sh NAME
35.Nm ip6addrctl
36.Nd configure address selection policy for IPv6 and IPv4
37.\"
38.Sh SYNOPSIS
39.Nm
40.Op Cm show
41.Nm
42.Cm add
43.Ar prefix precedence label
44.Nm
45.Cm delete
46.Ar prefix
47.Nm
48.Cm flush
49.Nm
50.Cm install
51.Ar configfile
52.\"
53.Sh DESCRIPTION
54The
55.Nm
56utility manages the policy table of source and destination address
57selection for outgoing IPv4 and IPv6 packets.
58When
59.Nm
60is invoked without an argument or with a single argument
61.Cm show ,
62it prints the content of the policy table currently installed in the
63kernel.
64.Pp
65To modify the table, the following operations are available:
66.Bl -tag -width indent
67.It Cm add Ar prefix precedence label
68Add a policy entry.
69The
70.Ar prefix
71argument
72is an IPv6 prefix, which is a key for the entry.
73An IPv4 prefix should be specified with an IPv6 prefix using an
74IPv4-mapped IPv6 address.
75The
76.Ar precedence
77and
78.Ar label
79arguments
80are decimal numbers, which specify the precedence and label values
81for the entry, respectively.
82This operation should be performed without an existing entry for the
83prefix.
84.It Cm delete Ar prefix
85Delete a policy entry specified by
86.Ar prefix ,
87which should be an IPv6 prefix.
88A corresponding entry for the prefix should have already been
89installed.
90.It Cm flush
91Delete all existing policy entries in the kernel.
92.It Cm install Ar configfile
93Install policy entries from a configuration file named
94.Ar configfile .
95The configuration file should contain a set of policy entries.
96Each entry is specified in a single line which contains an IPv6 prefix,
97a decimal precedence value, and a decimal label value, separated with
98white space or tab characters.
99In the configuration file, lines beginning with the pound-sign
100.Pq Ql #
101are
102comments and are ignored.
103.El
104.\"
105.Sh EXIT STATUS
106.Ex -std
107.\"
108.Sh SEE ALSO
109.Xr getaddrinfo 1 ,
110.Xr getaddrinfo 3
111.Rs
112.%A "Dave Thaler"
113.%A "Richard Draves"
114.%A "Arifumi Matsumoto"
115.%A "Tim Chown"
116.%T "Default Address Selection for Internet Protocol Version 6 (IPv6)"
117.%R RFC 6724
118.Re
119.\"
120.Sh HISTORY
121The
122.Nm
123utility first appeared in the KAME IPv6 protocol stack kit.
124The original command name was
125.Nm addrselect ,
126but it was then renamed to the current one so that the name would
127describe its function well.
128.\" .Sh BUGS
129.\" (to be written)
130