bindctl.1 4.83 KB
Newer Older
1 2 3 4
'\" t
.\"     Title: bindctl
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
.\"      Date: June 20, 2012
6 7 8 9
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
10
.TH "BINDCTL" "1" "June 20, 2012" "BIND10" "BIND10"
11
.\" -----------------------------------------------------------------
12 13 14 15 16 17 18 19 20
.\" * 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 '
.\" -----------------------------------------------------------------
21 22 23 24 25 26 27 28 29 30 31 32 33
.\" * 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
34
\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]
35 36
.SH "DESCRIPTION"
.PP
37
The
38 39 40 41
\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
Jeremy C. Reed's avatar
Jeremy C. Reed committed
42 43

\fBbindctl\fR
44
communicates over a HTTPS REST\-ful interface provided by
Jeremy C. Reed's avatar
Jeremy C. Reed committed
45 46
\fBb10-cmdctl\fR(8)\&. The
\fBb10-cfgmgr\fR(8)
47
daemon stores the configurations\&.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
.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
64 65
\fB\-\-csv\-file\-dir\fR\fIfile\fR
.RS 4
66
The directory name in which the user/password CSV file is stored (see AUTHENTICATION)\&. By default this option doesn\*(Aqt have any value, in which case the "\&.bind10" directory under the user\*(Aqs home directory will be used\&.
67 68
.RE
.PP
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
\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"
Jeremy C. Reed's avatar
Jeremy C. Reed committed
101
.PP
102
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
103 104 105
\fBbindctl\fR\&. The file name is "default_user\&.csv" located under the directory specified by the
\fB\-\-csv\-file\-dir\fR
option\&.
106
.SH "USAGE"
107
.PP
108
The
109
\fBbindctl\fR
110
prompt shows
111 112 113 114 115 116
\(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

117
\fBbindctl\fR\*(Aqs interactive interface provides command\-line completion and hints\&. Press the Tab key to get a hint for the module, command, and/or parameters\&.
118 119
The arrow keys and Emacs\-style editing keys may be used to edit and recall previous lines\&.
.PP
120
You can use the
121
\fBhelp\fR
122
keyword to receive usage assistance for a module or a module\*(Aqs command\&.
123
.PP
Jeremy C. Reed's avatar
Jeremy C. Reed committed
124
The
125
\fBquit\fR
Jeremy C. Reed's avatar
Jeremy C. Reed committed
126
command is used to exit
127
\fBbindctl\fR\&. (It doesn\*(Aqt stop the BIND 10 services\&.)
128 129 130 131
.PP
The following module is available by default:
\fBconfig\fR
for Configuration commands\&.
132
Additional modules may be available, such as
133 134 135 136 137 138 139 140 141 142 143
\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),
Jeremy C. Reed's avatar
Jeremy C. Reed committed
144
BIND 10 Guide\&.
145 146
.SH "AUTHORS"
.PP
147
The
148 149 150 151 152 153 154 155 156 157
\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