release/src/router/dhcpv6/dhcp6ctl.8

   1 .\"     $KAME: dhcp6ctl.8,v 1.4 2005/05/03 06:25:48 jinmei Exp $
   2 .\"
   3 .\" Copyright (C) 2004 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 September 7, 2004
  31 .Dt DHCP6CTL 8
  32 .Os KAME
  33 .Sh NAME
  34 .Nm dhcp6ctl
  35 .Nd DHCPv6 client and server control utility
  36 .\"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl C \(ba Fl S
  40 .Op Fl k Ar keyfile
  41 .Op Fl p Ar port
  42 .Op Fl s Ar address
  43 .Ic command
  44 .\"
  45 .Sh DESCRIPTION
  46 .Nm
  47 controls the operation of a DHCPv6 process,
  48 which is either
  49 .Nm dhcp6c
  50 or
  51 .Nm dhcp6s ,
  52 a DHCPv6 client or a server.
  53 By default,
  54 .Nm
  55 controls a client.
  56 The type of the process can also be specified explicitly by the
  57 .Fl C
  58 or
  59 .Fl S
  60 options.
  61 .Pp
  62 .Nm
  63 communicates with the DHCPv6 process over a TCP connection,
  64 sending commands authenticated with digital signatures.
  65 Currently,
  66 the only supported authentication algorithm is
  67 HMAC-MD5,
  68 which uses a shared secret on each end of the connection.
  69 .Pp
  70 Command line options are as below:
  71 .Bl -tag -width indent
  72 .\"
  73 .It Fl C
  74 Control a DHCPv6 client.
  75 This option is exclusive with the
  76 .Fl S
  77 option.
  78 .It Fl S
  79 Control a DHCPv6 server.
  80 This option is exclusive with the
  81 .Fl C
  82 option.
  83 .It Fl k Ar keyfile
  84 Use
  85 .Ar keyfile
  86 to provide the shared secret to communicate with the process.
  87 The default file name used when unspecified is
  88 .Pa /usr/local/etc/dhcp6cctlkey
  89 with a client,
  90 and
  91 .Pa /usr/local/etc/dhcp6sctlkey
  92 with a server.
  93
  94 .It Fl p Ar port
  95 Specify
  96 .Ar port
  97 as the listening port of the process.
  98 The default port number used when unspecified is 5546 for a client,
  99 and 5547 for a server.
 100 .It Fl s Ar address
 101 Specify
 102 .A address
 103 as the listening address of the process.
 104 The default address used when unspecified is ::1.
 105 .El
 106 .\"
 107 .Sh KEY FILE
 108 Since the operation available with the
 109 .Nm
 110 command is powerful,
 111 the communication between the command and
 112 .Nm dhcp6c
 113 or
 114 .Nm dhcp6s
 115 must be authenticated.
 116 The supported algorithm for authentication is HMAC-MD5,
 117 which requires a shared secret,
 118 and the secret is stored in the key file.
 119 The key file must consist of a single line, in which the secret value
 120 is written in the form of BASE-64 encoding.
 121 .\"
 122 .Sh COMMANDS
 123 Each
 124 .Ic command
 125 specifies a single control operation.
 126 Supported commands are as follows:
 127 .Pp
 128 .Bl -tag -width Ds -compact
 129 .It Xo
 130 .Ic reload
 131 .Xc
 132 This command specifies the process to reload the configuration file.
 133 Existing bindings, if any, are intact.
 134 .It Xo
 135 .Ic remove Ar arguments
 136 .Xc
 137 This command is only applicable to a server.
 138 This specifies the server to remove a run-time object
 139 specified by
 140 .Ar arguments
 141 from the server.
 142 Currently, the only possible object is one particular IA_NA or IA_PD
 143 binding, which is specified as
 144 .Ql Ic binding IA Ic IA_NA Ar IAID Ar DUID
 145 or
 146 .Ql Ic binding IA Ic IA_PD Ar IAID Ar DUID
 147 where
 148 .Ar IAID
 149 is a decimal number specifying the IAID of the IA,
 150 and
 151 .Ar DUID
 152 is a DHCP Unique Identifier of the binding.
 153 The format of
 154 .Ar DUID
 155 is the same as that specified in
 156 .Xr dhcp6s.conf 5 .
 157 .It Xo
 158 .Ic start Ic interface Ar ifname
 159 .Xc
 160 This command is only applicable to a client.
 161 It tells the client to release the current configuration information
 162 (if any) on the interface
 163 .Ar ifname
 164 and restart the DHCPv6 configuration process on the interface.
 165 .It Xo
 166 .Ic stop Ic interface Ar ifname
 167 .Xc
 168 This command is only applicable to a client.
 169 It tells the client to release the current configuration information
 170 (if any) on the interface
 171 .Ar ifname .
 172 Any timer running for the interface will be stopped,
 173 and no more DHCPv6 messages will be sent on the interface.
 174 The configuration process can later be restarted by the
 175 .Ic start
 176 command.
 177 .It Xo
 178 .Ic stop
 179 .Xc
 180 This command stops the specified process.
 181 If the process is a client, it will release all configuration
 182 information (if any) and exits.
 183 .El
 184 .\"
 185 .Sh FILES
 186 .Bl -tag -width /usr/local/etc/dhcp6cctlkey -compact
 187 .It Pa /usr/local/etc/dhcp6cctlkey
 188 is the default key file to communicate with a client.
 189 .It Pa /usr/local/etc/dhcp6sctlkey
 190 is the default key file to communicate with a server.
 191 .El
 192 .\"
 193 .Sh SEE ALSO
 194 .Xr dhcp6s.conf 5
 195 .Xr dhcp6s 8
 196 .\"
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 command first appeared in WIDE/KAME IPv6 protocol stack kit.