1DHCP6CTL(8) BSD System Manager's Manual DHCP6CTL(8)
2
4 dhcp6ctl — DHCPv6 client and server control utility
5
7 dhcp6ctl [-C -| -S] [-k keyfile] [-p port] [-s address] command
8
10 dhcp6ctl controls the operation of a DHCPv6 process, which is either
11 dhcp6c or dhcp6s, a DHCPv6 client or a server. By default, dhcp6ctl con‐
12 trols a client. The type of the process can also be specified explicitly
13 by the -C or -S options.
14 dhcp6ctl communicates with the DHCPv6 process over a TCP connection,
16 sending commands authenticated with digital signatures. Currently, the
17 only supported authentication algorithm is HMAC-MD5, which uses a shared
18 secret on each end of the connection.
19 Command line options are as below:
21 -C Control a DHCPv6 client. This option is exclusive with the -S
23 option.
24 -S Control a DHCPv6 server. This option is exclusive with the -C
26 option.
27 -k keyfile
29 Use keyfile to provide the shared secret to communicate with the
30 process. The default file name used when unspecified is
31 /etc/wide-dhcpv6/dhcp6cctlkey with a client, and
32 /etc/wide-dhcpv6/dhcp6sctlkey with a server.
33 -p port
35 Specify port as the listening port of the process. The default
36 port number used when unspecified is 5546 for a client, and 5547
37 for a server.
38 -s address
40 Specify address as the listening address of the process. The
41 default address used when unspecified is ::1.
42
44 Since the operation available with the dhcp6ctl command is powerful, the
45 communication between the command and dhcp6c or dhcp6s must be authenti‐
46 cated. The supported algorithm for authentication is HMAC-MD5, which
47 requires a shared secret, and the secret is stored in the key file. The
48 key file must consist of a single line, in which the secret value is
49 written in the form of BASE-64 encoding.
50
52 Each command specifies a single control operation. Supported commands
53 are as follows:
54 reload This command specifies the process to reload the configuration
56 file. Existing bindings, if any, are intact.
57 remove arguments
58 This command is only applicable to a server. This specifies the
59 server to remove a run-time object specified by arguments from
60 the server. Currently, the only possible object is one particu‐
61 lar IA_NA or IA_PD binding, which is specified as ‘binding IA
62 IA_NA IAID DUID’ or ‘binding IA IA_PD IAID DUID’ where IAID is a
63 decimal number specifying the IAID of the IA, and DUID is a DHCP
64 Unique Identifier of the binding. The format of DUID is the same
65 as that specified in dhcp6s.conf(5).
66 start interface ifname
67 This command is only applicable to a client. It tells the client
68 to release the current configuration information (if any) on the
69 interface ifname and restart the DHCPv6 configuration process on
70 the interface.
71 stop interface ifname
72 This command is only applicable to a client. It tells the client
73 to release the current configuration information (if any) on the
74 interface ifname. Any timer running for the interface will be
75 stopped, and no more DHCPv6 messages will be sent on the inter‐
76 face. The configuration process can later be restarted by the
77 start command.
78 stop This command stops the specified process. If the process is a
79 client, it will release all configuration information (if any)
80 and exits.
81
83 /etc/wide-dhcpv6/dhcp6cctlkey is the default key file to communicate
84 with a client.
85 /etc/wide-dhcpv6/dhcp6sctlkey is the default key file to communicate
86 with a server.
87
89 dhcp6s.conf(5) dhcp6s(8)
90
92 The dhcp6ctl command first appeared in WIDE/KAME IPv6 protocol stack kit.
93KAME September 7, 2004 KAME