kea/src/bin/cmdctl/b10-cmdctl.8

'\" t
.\"     Title: b10-cmdctl
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: February 28, 2012
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
.TH "B10\-CMDCTL" "8" "February 28, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
b10-cmdctl \- BIND 10 remote control daemon
.SH "SYNOPSIS"
.HP \w'\fBb10\-cmdctl\fR\ 'u
\fBb10\-cmdctl\fR [\fB\-a\ \fR\fB\fIstring\fR\fR] [\fB\-h\fR] [\fB\-i\ \fR\fB\fInumber\fR\fR] [\fB\-p\ \fR\fB\fInumber\fR\fR] [\fB\-v\fR] [\fB\-\-address\ \fR\fB\fIstring\fR\fR] [\fB\-\-help\fR] [\fB\-\-idle\-timeout\ \fR\fB\fInumber\fR\fR] [\fB\-\-port\ \fR\fB\fInumber\fR\fR] [\fB\-\-verbose\fR] [\fB\-\-version\fR]
.SH "DESCRIPTION"
.PP
The
\fBb10\-cmdctl\fR
daemon provides an entry for commands sent to the BIND 10 services\&. For example, the
\fBbindctl\fR
user interface communicates via
\fBb10\-cmdctl\fR\&.
.PP
It is a lightweight HTTPS server with HTTP Digest Authentication (username and password validation)\&. It offers a RESTful style interface\&.
.SH "OPTIONS"
.PP
The arguments are as follows:
.PP
\fB\-a \fR\fB\fIstring\fR\fR, \fB\-\-address \fR\fB\fIstring\fR\fR
.RS 4
The IP address that
\fBb10\-cmdctl\fR
will listen on\&. The default is 127\&.0\&.0\&.1\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display command usage\&.
.RE
.PP
\fB\-i \fR\fB\fInumber\fR\fR, \fB\-\-idle\-timeout \fR\fB\fInumber\fR\fR
.RS 4
The socket idle timeout for the HTTPS connection in seconds\&. The default is 1200 seconds\&.
.RE
.PP
\fB\-p \fR\fB\fInumber\fR\fR, \fB\-\-port \fR\fB\fInumber\fR\fR
.RS 4
The port number
\fBb10\-cmdctl\fR
will listen on\&. The default is 8080\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Enable verbose mode\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Display the version number and exit\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
The configurable settings are:
.PP

\fIaccounts_file\fR
defines the path to the user accounts database\&. The default is
/usr/local/etc/bind10\-devel/cmdctl\-accounts\&.csv\&.
.PP

\fIcert_file\fR
defines the path to the PEM certificate file\&. The default is
/usr/local/etc/bind10\-devel/cmdctl\-certfile\&.pem\&.
.PP

\fIkey_file\fR
defines the path to the PEM private key file\&. The default is
/usr/local/etc/bind10\-devel/cmdctl\-keyfile\&.pem\&.
.PP
The configuration command is:
.PP

\fBshutdown\fR
exits
\fBb10\-cmdctl\fR\&. This has an optional
\fIpid\fR
argument to select the process ID to stop\&. (Note that the BIND 10 boss process may restart this service if configured\&.)
.SH "FILES"
.PP
/usr/local/etc/bind10\-devel/cmdctl\-accounts\&.csv
\(em account database containing the name, hashed password, and the salt\&.
.PP
/usr/local/etc/bind10\-devel/cmdctl\-keyfile\&.pem
\(em contains the Private key\&.
.PP
/usr/local/etc/bind10\-devel/cmdctl\-certfile\&.pem
\(em contains the Certificate\&.
.SH "SEE ALSO"
.PP

\fBb10-cfgmgr\fR(8),
\fBbind10\fR(8),
\fBbindctl\fR(1)\&.
.SH "AUTHORS"
.PP
The
\fBb10\-cmdctl\fR
daemon was initially designed and coded by Zhang Likun of CNNIC\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010-2012 Internet Systems Consortium, Inc. ("ISC")
.br