dhcp6ctl(8) [debian man page]
DHCP6CTL(8) BSD System Manager's Manual DHCP6CTL(8) NAME
dhcp6ctl -- DHCPv6 client and server control utility SYNOPSIS
dhcp6ctl [-C -| -S] [-k keyfile] [-p port] [-s address] command DESCRIPTION
dhcp6ctl controls the operation of a DHCPv6 process, which is either dhcp6c or dhcp6s, a DHCPv6 client or a server. By default, dhcp6ctl controls a client. The type of the process can also be specified explicitly by the -C or -S options. dhcp6ctl communicates with the DHCPv6 process over a TCP connection, sending commands authenticated with digital signatures. Currently, the only supported authentication algorithm is HMAC-MD5, which uses a shared secret on each end of the connection. Command line options are as below: -C Control a DHCPv6 client. This option is exclusive with the -S option. -S Control a DHCPv6 server. This option is exclusive with the -C option. -k keyfile Use keyfile to provide the shared secret to communicate with the process. The default file name used when unspecified is /etc/wide-dhcpv6/dhcp6cctlkey with a client, and /etc/wide-dhcpv6/dhcp6sctlkey with a server. -p port Specify port as the listening port of the process. The default port number used when unspecified is 5546 for a client, and 5547 for a server. -s address Specify address as the listening address of the process. The default address used when unspecified is ::1. KEY FILE
Since the operation available with the dhcp6ctl command is powerful, the communication between the command and dhcp6c or dhcp6s must be authenticated. The supported algorithm for authentication is HMAC-MD5, which requires a shared secret, and the secret is stored in the key file. The key file must consist of a single line, in which the secret value is written in the form of BASE-64 encoding. COMMANDS
Each command specifies a single control operation. Supported commands are as follows: reload This command specifies the process to reload the configuration file. Existing bindings, if any, are intact. remove arguments This command is only applicable to a server. This specifies the server to remove a run-time object specified by arguments from the server. Currently, the only possible object is one particular IA_NA or IA_PD binding, which is specified as 'binding IA IA_NA IAID DUID' or 'binding IA IA_PD IAID DUID' where IAID is a decimal number specifying the IAID of the IA, and DUID is a DHCP Unique Identi- fier of the binding. The format of DUID is the same as that specified in dhcp6s.conf(5). start interface ifname This command is only applicable to a client. It tells the client to release the current configuration information (if any) on the interface ifname and restart the DHCPv6 configuration process on the interface. stop interface ifname This command is only applicable to a client. It tells the client to release the current configuration information (if any) on the interface ifname. Any timer running for the interface will be stopped, and no more DHCPv6 messages will be sent on the interface. The configuration process can later be restarted by the start command. stop This command stops the specified process. If the process is a client, it will release all configuration information (if any) and exits. FILES
/etc/wide-dhcpv6/dhcp6cctlkey is the default key file to communicate with a client. /etc/wide-dhcpv6/dhcp6sctlkey is the default key file to communicate with a server. SEE ALSO
dhcp6s.conf(5) dhcp6s(8) HISTORY
The dhcp6ctl command first appeared in WIDE/KAME IPv6 protocol stack kit. KAME
September 7, 2004 KAME
Check Out this Related Man Page
dhcp6c.conf(5) File Formats Manual dhcp6c.conf(5) NAME
dhcp6c.conf - configuration file of the DHCPv6 client daemon, dhcp6c DESCRIPTION
dhcp6c.conf is a configuration file for dhcp6c (DHCPv6 client). dhcp6c is configured by the configuration information (such as rapid-commit, requesting temp-address, or prefix-delegation) in this file. dhcp6c.conf is an ASCII text file and lines that start with # are comments. STATEMENTS
interface <interface name> { [declarations] }; Write configurations for this interface in this statement. In [declarations], options can be specified. DECLARATIONS
send [dhcpoptions]; With this declaration, dhcp6c sends specified options. Currently rapid-commit is defined. send rapid-commit; This declaration enables dhcp6c to request the dhcp6s server to perform a Rapid Commit. request [dhcpoptions]; This declaration enables dhcp6c to request specified options. Currently temp-address, domain-name-servers, and prefix-delegation are defined. request domain-name-servers; The DHCPv6 mechanism provides a way to obtain configuration information such as a list of available DNS servers or NTP servers. This decla- ration enables dhcp6c to request a DNS server address from the DHCPv6 server. request domain-search-list; This declaration enables dhcp6c to request a domain search list which dhcp6c uses when resolving hostnames with DNS. request prefix-delegation; This declaration enables dhcp6c to request a Prefix Delegation to the DHCPv6 server. dhcp6c gets a prefix assignment from the DHCPv6 server. request temp-address; This declaration enables dhcp6c to request temporary addresses. dhcp6c requests Non-temporary Addresses as default. This option makes dhcp6c request Temporary Addresses. information-only; This declaration enables dhcp6c to request host configuration information from the DHCPv6 server. If dhcp6c doesn't need to be assigned any addresses, this option should be specified. default-information-refresh-time <information refresh time>; This declaration defines the default interval to refresh the host configuration information retrieved from a server. When a server offers an interval to dhcp6c, dhcp6c chooses the interval from server. If this declaration is not specified, the interval is 86400[sec] (24 hours). The minimum interval is 400[sec]. If you don't want to refresh the information, specify infinity as the interval. maximum-information-refresh-time <information refresh time>; This declaration defines the maximum interval to refresh the host configuration information retrieved from a server. When DHCPv6 server offers an interval which is bigger than this maximum interval, dhcp6c chooses this maximum interval. If this declaration is not specified, dhcp6c uses the interval which a server offered or the interval which is specified at default-information-refresh-time declaration. address { [<ipv6 address>/<prefix length>]; [prefer-life-time <preferred-lifetime>]; [valid-life-time <valid-lifetime>]; }; This declaration defines the dhcp6c client preferred IPv6 address, the preferred lifetime of the address, and the valid lifetime for this interface. prefix { [<ipv6 prefix>/<prefix length>]; [prefer-life-time <preferred-lifetime>]; [valid-life-time <valid-lifetime>]; }; This declaration defines the dhcp6c client acting as a requesting router for the preferred prefix, the prefix length, and the prefix's pre- ferred lifetime, and valid lifetime for this interface. prefer-life-time <preferred-lifetime>; This declaration sets the preferred lifetime (in seconds) of the address or prefix. This declaration is valid only in address or prefix declarations. valid-life-time <valid-lifetime>; This declaration sets the valid lifetime (in seconds) of the address or prefix. This declaration is valid only in address or prefix decla- rations. renew-time <renew-time>; This declaration specifies the Renew Time (in seconds) for this Identity Association (IA). Renew Time is a T1 value in an IA option. dhcp6c sets the Renew Time in IA options to the specified value. rebind-time <rebind-time>; This declaration specifies the Rebind Time (in seconds) for this IA. Rebind Time is T2 value in an IA option. dhcp6c sets the Rebind Time in IA options to the specified value. DHCPOPTIONS
rapid-commit If this option is used in a "send [dhcpoptions];" declaration, dhcp6c sends DHCPv6 messages with a Rapid Commit option. domain-name-servers If this option is used in a "request [dhcpoptions];" declaration, dhcp6c requests the DNS server address via the DHCPv6 mechanism. prefix-delegation If this option is used in a "request [dhcpoptions];" declaration, dhcp6c requests a Prefix Delegation to the DHCPv6 servers. prefix-delegation-interface <interface name> Specifies the name of the interface definition in radvd.conf that dhcp6c will write the 'prefix' declaration for. By default, dhcp6c will write a radvd.conf prefix declaration for the interface on which it receives the prefix delegation lease. EXAMPLES
This is a sample of the dhcp6c.conf file. interface eth0 { send rapid-commit; request prefix-delegation; request domain-name-servers; request temp-address; iaid 11111; address { 3ffe:10::10/64; prefer-life-time 6000; valid-life-time 8000; }; renew-time 11000; rebind-time 21000; }; SEE ALSO
dhcp6c(8) BUGS
Report bugs via http://fedorahosted.org/dhcpv6/ AUTHORS
See http://fedorahosted.org/dhcpv6/wiki/Authors dhcp6c.conf(5)