| blob | 5f14cbf941b92276a6dfcf60d472a024740c7fe8 |
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH VNTSD 8 "Mar 31, 2009"
7 .SH NAME
8 vntsd \- virtual network terminal server daemon for Logical Domains
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/lib/ldoms/vntsd\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBvntsd\fR daemon is a server that supports connections to the Logical
19 Domains (LDoms) console by using \fBtelnet\fR(1). When a \fBtelnet\fR session
20 starts, \fBvntsd\fR sends \fBtelnet\fR options to the client indicating a
21 willingness to remotely echo characters and to suppress go ahead.
22 .sp
23 .LP
24 Consoles are organized into groups by the LDoms Manager. Each console group is
25 assigned a unique group name and TCP port number. \fBvntsd\fR uses the group's
26 port number to export access to the consoles within that group. To establish a
27 connection with a console or console group, a user starts a \fBtelnet\fR(1)
28 session with the corresponding group's port number. Depending on the number of
29 consoles within that group, \fBvntsd\fR does one of two things:
30 .RS +4
31 .TP
32 .ie t \(bu
33 .el o
34 If there is only one console in the group, \fBvntsd\fR connects a session to
35 that LDoms console.
36 .RE
37 .RS +4
38 .TP
39 .ie t \(bu
40 .el o
41 If there are multiple consoles in the group, \fBvntsd\fR prompts the user to
42 select the console to which they would like to connect, as shown in
43 "Multiple-Console Options," below.
44 .RE
45 .sp
46 .LP
47 For each console, \fBvntsd\fR provides write access only to the first user
48 connecting to the console. Subsequent users connecting to the console are
49 allowed only to read from the console and wait for write access. When the first
50 user disconnects, write privileges are transferred to the next user waiting in
51 the queue. If a user who does not have write privileges attempts to write to a
52 console, the \fBvntsd\fR displays the following message:
53 .sp
54 .in +2
55 .nf
56 You do not have write access
57 .fi
58 .in -2
60 .sp
61 .LP
62 A user who has no write access can acquire write access forcibly by using the
63 \fB~w\fR special console command, described in "Special Console Commands,"
64 below.
65 .sp
66 .LP
67 \fBvntsd\fR can be invoked only with superuser privileges or by someone in the
68 Primary Administrator role.
69 .SH OPTIONS
70 .sp
71 .LP
72 The options for \fBvntsd\fR are divided into multiple-console options and
73 console commands.
74 .SS "Multiple-Console Options"
75 .sp
76 .LP
77 The options listed below are supported when there are multiple LDoms consoles
78 in a group. The syntax for the use of these options is:
79 .sp
80 .in +2
81 .nf
82 \fI<hostname>\fR-vnts-\fI<group-name>\fR: \fI<option>\fR
83 .fi
84 .in -2
86 .sp
87 .LP
88 For example:
89 .sp
90 .in +2
91 .nf
92 myhost-vnts-salesgroup: h
93 .fi
94 .in -2
96 .sp
97 .LP
98 The \fBh\fR option invokes help, as described below.
99 .sp
100 .ne 2
101 .na
102 \fB\fBh\fR\fR
103 .ad
104 .sp .6
105 .RS 4n
106 Display the following help text:
107 .sp
108 .in +2
109 .nf
110 h -- this help
111 l -- list of consoles
112 q -- quit
113 c{id}, n{name} -- connect to console of domain {id} or domain name
114 .fi
115 .in -2
117 .RE
119 .sp
120 .ne 2
121 .na
122 \fB\fBl\fR\fR
123 .ad
124 .sp .6
125 .RS 4n
126 List all consoles in the group. For example:
127 .sp
128 .in +2
129 .nf
130 DOMAIN ID DOMAIN NAME DOMAIN STATE
131 0 ldg1 online
132 1 ldg2 connected
133 \&... ... ...
134 .fi
135 .in -2
137 The two domain states and their meanings are:
138 .sp
139 .ne 2
140 .na
141 \fB\fBonline\fR\fR
142 .ad
143 .sp .6
144 .RS 4n
145 No one is connected to the console.
146 .RE
148 .sp
149 .ne 2
150 .na
151 \fB\fBconnected\fR\fR
152 .ad
153 .sp .6
154 .RS 4n
155 At least one user is already connected to the console.
156 .RE
158 .RE
160 .sp
161 .ne 2
162 .na
163 \fB\fBq\fR\fR
164 .ad
165 .sp .6
166 .RS 4n
167 Disconnect from \fBvntsd\fR.
168 .RE
170 .sp
171 .ne 2
172 .na
173 \fB\fBc\fI{id}\fR, n\fI{name}\fR\fR\fR
174 .ad
175 .sp .6
176 .RS 4n
177 Connect to specified console. Upon connection, the following message is
178 displayed:
179 .sp
180 .in +2
181 .nf
182 Connecting to console \fI<domain-name>\fR in group \fI<group-name>\fR
183 Press ~? for control options ....
184 .fi
185 .in -2
187 .RE
189 .SS "Special Console Commands"
190 .sp
191 .LP
192 A tilde (\fB~\fR) appearing as the first character of a line is an escape
193 signal that directs \fBvntsd\fR to perform a special console command. The
194 tilde-tilde (\fB~~\fR) sequence outputs a tilde. In conjunction with the
195 initial tilde, \fBvntsd\fR accepts the following special console commands:
196 .sp
197 .ne 2
198 .na
199 \fB\fB~.\fR\fR
200 .ad
201 .sp .6
202 .RS 4n
203 Disconnect from the console or console group.
204 .RE
206 .sp
207 .ne 2
208 .na
209 \fB\fB~w\fR\fR
210 .ad
211 .sp .6
212 .RS 4n
213 Force write access to the console.
214 .RE
216 .sp
217 .ne 2
218 .na
219 \fB\fB~p\fR\fR
220 .ad
221 .sp .6
222 .RS 4n
223 Disconnect from this console, and connect to the console that precedes this
224 console in the list of consoles.
225 .RE
227 .sp
228 .ne 2
229 .na
230 \fB\fB~n\fR\fR
231 .ad
232 .sp .6
233 .RS 4n
234 Disconnect from this console, and connect to the console that follows this
235 console in the list of consoles.
236 .RE
238 .sp
239 .ne 2
240 .na
241 \fB\fB~#\fR\fR
242 .ad
243 .sp .6
244 .RS 4n
245 Send break.
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fB\fB~^B\fR\fR
252 .ad
253 .sp .6
254 .RS 4n
255 Send alternate break.
256 .RE
258 .sp
259 .ne 2
260 .na
261 \fB\fB~?\fR\fR
262 .ad
263 .sp .6
264 .RS 4n
265 Display \fBvntsd\fR help, as follows:
266 .sp
267 .in +2
268 .nf
269 ~# - Send break
270 ~^B - Send alternate break
271 ~. - Exit from this console
272 ~w - Force write access
273 ~n - Console next
274 ~p - Console previous
275 ~? - Help
276 .fi
277 .in -2
279 .RE
281 .SH FILES
282 .sp
283 .ne 2
284 .na
285 \fB\fB/usr/lib/ldoms/vntsd\fR\fR
286 .ad
287 .sp .6
288 .RS 4n
289 Binary executable \fBvntsd\fR file.
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fB/usr/lib/ldoms/vntsd.xml\fR\fR
296 .ad
297 .sp .6
298 .RS 4n
299 Service management facility (\fBsmf\fR(5)) manifest file for \fBvntsd\fR.
300 .RE
302 .SH ATTRIBUTES
303 .sp
304 .LP
305 See \fBattributes\fR(5) for descriptions of the following attributes:
306 .sp
308 .sp
309 .TS
310 box;
311 c | c
312 l | l .
313 ATTRIBUTE TYPE ATTRIBUTE VALUE
314 _
315 Interface Stability Evolving
316 .TE
318 .SH SEE ALSO
319 .sp
320 .LP
321 \fBtelnet\fR(1), \fBsvccfg\fR(8), \fBusermod\fR(8), \fBauth_attr\fR(4),
322 \fBattributes\fR(5), \fBsmf\fR(5)
323 .SH NOTES
324 .sp
325 .LP
326 The \fBvntsd\fR is managed by the service management facility, \fBsmf\fR(5),
327 under the service identifier:
328 .sp
329 .in +2
330 .nf
331 svc:/ldoms/vntsd
332 .fi
333 .in -2
335 .sp
336 .LP
337 You can change the following properties using the \fBsvccfg\fR(8) command:
338 .sp
339 .ne 2
340 .na
341 \fB\fBvntsd/vcc_device\fR\fR
342 .ad
343 .sp .6
344 .RS 4n
345 Set an instance of the virtual console concentrator (\fBvcc\fR) driver to which
346 \fBvntsd\fR is connected.
347 .RE
349 .sp
350 .ne 2
351 .na
352 \fB\fBvntsd/listen_addr\fR\fR
353 .ad
354 .sp .6
355 .RS 4n
356 Set the IP address to which \fBvntsd\fR listens, using the following syntax:
357 .sp
358 .in +2
359 .nf
360 vntsd/listen_addr:"\fIxxx.xxx.xxx.xxx\fR"
361 .fi
362 .in -2
364 \&...where \fIxxx.xxx.xxx.xxx\fR is a valid IP address. The default value of
365 this property is to listen on IP address 127.0.0.1. Users can connect to a
366 guest console over a network if the value is set to the IP address of the
367 control domain.
368 .LP
369 Note -
370 .sp
371 .RS 2
372 Enabling network access to a console has security implications. Any user can
373 connect to a console and for this reason it is disabled by default.
374 .RE
375 .RE
377 .sp
378 .ne 2
379 .na
380 \fB\fBvntsd/timeout_minutes\fR\fR
381 .ad
382 .sp .6
383 .RS 4n
384 Set timeout in minutes. \fBvntsd\fR will timeout (close) \fBtelnet\fR
385 connection if there is no activity (input or output) on the console. The
386 default value is 0, which disables timeout.
387 .RE
389 .sp
390 .ne 2
391 .na
392 \fB\fBvntsd/authorization\fR\fR
393 .ad
394 .sp .6
395 .RS 4n
396 Enable the authorization checking of users and roles for the domain console or
397 consoles that are being accessed. The default value of this property is
398 \fBfalse\fR to maintain backward compatibility. To enable authorization
399 checking, use the \fBsvccfg\fR(8) command to set the property value to
400 \fBtrue\fR. While this option is enabled, \fBvntsd\fR listens and accepts
401 connections on \fBlocalhost\fR. If the \fBlisten_addr\fR property specifies an
402 alternate IP address when this option is enabled, \fBvntsd\fR ignores the
403 alternate IP address and continues to listen on \fBlocalhost\fR. Connections
404 that are initiated from other hosts will also fail. Authorizations are
405 available to access all consoles or console groups, or to access specific
406 consoles or console groups. When the \fBvntsd\fR service is enabled, the
407 following authorization is added to the authorization description database,
408 \fBauth_attr\fR(4):
409 .sp
410 .in +2
411 .nf
412 solaris.vntsd.consoles:::Access All LDoms Guest Consoles::
413 .fi
414 .in -2
415 .sp
417 Add any fine-grained authorizations based on the name of the console group. For
418 example, if the name of the console group to be authorized is \fBldg1\fR, add
419 the following entry to the \fBauth_attr\fR(4) file:
420 .sp
421 .in +2
422 .nf
423 solaris.vntsd.console-ldg1:::Access Specific LDoms Guest Console::
424 .fi
425 .in -2
426 .sp
428 By default, the authorization to access all consoles is assigned to the root
429 user or role. The Primary Administrator (superuser) can use the
430 \fBusermod\fR(8) command to assign the required authorization or
431 authorizations to other users or roles.
432 .sp
433 The following example gives user \fBuser1\fR the authorization to access all
434 domain consoles:
435 .sp
436 .in +2
437 .nf
438 # \fBusermod -A "solaris.vntsd.consoles" user1\fR
439 .fi
440 .in -2
441 .sp
443 The following example gives user \fBuser1\fR the authorization to access the
444 console group named \fBldg1\fR:
445 .sp
446 .in +2
447 .nf
448 # \fBusermod -A "solaris.vntsd.console-ldg1" user1\fR
449 .fi
450 .in -2
451 .sp
453 .RE