kea/src/bin/bindctl/bindctl.1

'\" t
.\"     Title: bindctl
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: December 23, 2010
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
.TH "BINDCTL" "1" "December 23, 2010" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bindctl \- control and configure BIND 10
.SH "SYNOPSIS"
.HP \w'\fBbindctl\fR\ 'u
\fBbindctl\fR [\fB\-a\ \fR\fB\fIaddress\fR\fR] [\fB\-h\fR] [\fB\-c\ \fR\fB\fIfile\fR\fR] [\fB\-p\ \fR\fB\fInumber\fR\fR] [\fB\-\-address\ \fR\fB\fIaddress\fR\fR] [\fB\-\-help\fR] [\fB\-\-certificate\-chain\ \fR\fB\fIfile\fR\fR] [\fB\-\-csv\-file\-dir\fR\fB\fIfile\fR\fR] [\fB\-\-port\ \fR\fB\fInumber\fR\fR] [\fB\-\-version\fR]
.SH "DESCRIPTION"
.PP
The
\fBbindctl\fR
tool is a user interface to the BIND 10 services\&. The program can be used to control the components and configure the BIND 10 options\&. The options may be specified
via its interactive command interpreter\&.
.PP

\fBbindctl\fR
communicates over a HTTPS REST\-ful interface provided by
\fBb10-cmdctl\fR(8)\&. The
\fBb10-cfgmgr\fR(8)
daemon stores the configurations and defines the commands\&.
.SH "ARGUMENTS"
.PP
The arguments are as follows:
.PP
\fB\-a\fR \fIaddress\fR, \fB\-\-address\fR \fIaddress\fR
.RS 4
The IPv4 or IPv6 address to use to connect to the running
\fBb10-cmdctl\fR(8)
daemon\&. The default is 127\&.0\&.0\&.1\&.
.RE
.PP
\fB\-c\fR \fIfile\fR, \fB\-\-certificate\-chain\fR \fIfile\fR
.RS 4
The PEM formatted server certificate validation chain file\&.
.RE
.PP
\fB\-\-csv\-file\-dir\fR\fIfile\fR
.RS 4
The directory name in which the user/password CSV file is stored (see AUTHENTICATION)\&. By default this option doesn\'t have any value, in which case the "\&.bind10" directory under the user\'s home directory will be used\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display command usage\&.
.RE
.PP
\fB\-p\fR \fInumber\fR, \fB\-\-port\fR \fInumber\fR
.RS 4
The port number to use to connect to the running
\fBb10-cmdctl\fR(8)
daemon\&. The default is 8080\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
This default port number may change\&.
.sp .5v
.RE
.RE
.PP
\fB\-\-version\fR
.RS 4
Display the version number and exit\&.
.RE
.SH "AUTHENTICATION"
.PP
The tool will authenticate using a username and password\&. On the first successful login, it will save the details to a comma\-separated\-value (CSV) file which will be used for later uses of
\fBbindctl\fR\&. The file name is
default_user\&.csv
located under the directory specified by the \-\-csv\-file\-dir option\&.
.SH "USAGE"
.PP
The
\fBbindctl\fR
prompt shows
\(lq> \(rq\&. The prompt will also display the location if changed\&. The options are based on the module in use\&. The usage is:
\fBmodule\fR
\fBcommand\fR
\fIparam1 = value1 , \fR\fI\fIparam2 = value2\fR\fR
.PP

\fBbindctl\fR\'s interactive interface provides command\-line completion and hints\&. Press the Tab key to get a hint for the module, command, and/or parameters\&.
The arrow keys and Emacs\-style editing keys may be used to edit and recall previous lines\&.
.PP
You can use the
\fBhelp\fR
keyword to receive usage assistance for a module or a module\'s command\&.
.PP
The
\fBquit\fR
command is used to exit
\fBbindctl\fR
(and doesn\'t stop the BIND 10 services)\&.
.PP
The following module is available by default:
\fBconfig\fR
for Configuration commands\&.
Additional modules may be available, such as
\fBBoss\fR,
\fBXfrin\fR, and
\fBAuth\fR\&.
.SH "SEE ALSO"
.PP

\fBb10-auth\fR(8),
\fBb10-cfgmgr\fR(8),
\fBb10-cmdctl\fR(8),
\fBb10-xfrin\fR(8),
\fBbind10\fR(8),
BIND 10 Guide\&.
.SH "AUTHORS"
.PP
The
\fBbindctl\fR
tool and library were initially coded by Zhang Likun of CNNIC for the BIND 10 project\&. The initial manual page was written by Jeremy C\&. Reed of ISC\&.
.SH "HISTORY"
.PP
The initial version (with internal name of
\fBBigTool\fR) was started in October 2009\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
.br