Print this page
5700 add zlogin -d option to allow graceful disconnect when zone is halted
Reviewed by: Andrew Gabriel <illumos@cucumber.demon.co.uk>
Reviewed by: Jerry Jelinek <jerry.jelinek@joyent.com>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/zlogin.1.man.txt
+++ new/usr/src/man/man1/zlogin.1.man.txt
1 1 ZLOGIN(1) User Commands ZLOGIN(1)
2 2
3 3
4 4
5 5 NAME
6 6 zlogin - enter a zone
7 7
8 8 SYNOPSIS
9 - zlogin [-CEQ] [-e c] [-l username] zonename
9 + zlogin [-dCEQ] [-e c] [-l username] zonename
10 10
11 11
12 12 zlogin [-nEQS] [-e c] [-l username] zonename utility
13 13 [argument]...
14 14
15 15
16 16 DESCRIPTION
17 17 The zlogin utility is used by the administrator to enter an operating
18 18 system zone. Only a superuser operating in the global system zone can
19 19 use this utility.
20 20
21 21
22 22 zlogin operates in one of three modes:
23 23
24 24 Interactive Mode
25 25 If no utility argument is given and the stdin
26 26 file descriptor for the zlogin process is a tty
27 27 device, zlogin operates in interactive mode. In
28 28 this mode, zlogin creates a new pseudo terminal
29 29 for use within the login session. Programs
30 30 requiring a tty device, for example, vi(1),
31 31 work properly in this mode. In this mode,
32 32 zlogin invokes login(1) to provide a suitable
33 33 login session.
34 34
35 35
36 36 Non-Interactive Mode
37 37 If a utility is specified, zlogin operates in
38 38 non-interactive mode. This mode can be useful
39 39 for script authors since stdin, stdout, and
40 40 stderr are preserved and the exit status of
41 41 utility is returned upon termination. In this
42 42 mode, zlogin invokes su(1M) in order to set up
43 43 the user's environment and to provide a login
44 44 environment.
45 45
46 46 The specified command is passed as a string and
47 47 interpreted by a shell running in the non-global
48 48 zone. See rsh(1).
49 49
50 50
51 51 Console Mode
52 52 If the -C option is specified, the user is
53 53 connected to the zone console device and zlogin
54 54 operates in console mode. The zone console is
55 55 available once the zone is in the installed
56 56 state. Connections to the console are
|
↓ open down ↓ |
37 lines elided |
↑ open up ↑ |
57 57 persistent across reboot of the zone.
58 58
59 59
60 60 OPTIONS
61 61 The following options are supported:
62 62
63 63 -C
64 64 Connects to the zone console.
65 65
66 66
67 + -d
68 + Disconnect from the console when the zone halts. This
69 + option may only be used if the -C option is specified.
70 +
71 +
67 72 -e c
68 73 Specifies a different escape character, c, for the key
69 74 sequence used to access extended functions and to
70 75 disconnect from the login. The default escape character
71 76 is the tilde (~).
72 77
73 78
74 79 -E
75 80 Disables the ability to access extended functions or to
76 81 disconnect from the login by using the escape sequence
77 82 character.
78 83
79 84
80 85 -l username
81 86 Specifies a different username for the zone login. If
82 87 you do not use this option, the zone username used is
83 88 "root". This option is invalid if the -C option is
84 89 specified.
85 90
86 91
87 92 -n
88 93 Redirect the input of zlogin to /dev/null. This option
89 94 is useful when the command running in the local zone and
90 95 the shell which invokes zlogin both read from standard
91 96 input.
92 97
93 98
94 99 -Q
95 100 Specifies quiet mode operation. In quiet mode, extra
96 101 messages indicating the the function of zlogin will not
97 102 be displayed, giving the possibility to present the
98 103 appearance that the command is running locally rather
99 104 than in another zone.
100 105
101 106
102 107 -S
103 108 "Safe" login mode. zlogin does minimal processing and
104 109 does not invoke login(1) or su(1M). The -S option can not
105 110 be used if a username is specified through the -l option,
106 111 and cannot be used with console logins. This mode should
107 112 only be used to recover a damaged zone when other forms
108 113 of login have become impossible.
109 114
110 115
111 116 Escape Sequences
112 117 Lines that you type that start with the tilde character (~) are "escape
113 118 sequences". The escape character can be changed using the -e option.
114 119
115 120 ~.
116 121 Disconnects from the zone. This is not the same as a logout,
117 122 because the local host breaks the connection with no warning to
118 123 the zone's end.
119 124
120 125
121 126 SECURITY
122 127 Once a process has been placed in a zone other than the global zone,
123 128 the process cannot change zone again, nor can any of its children.
124 129
125 130 OPERANDS
126 131 The following operands are supported:
127 132
128 133 zonename
129 134 The name of the zone to be entered.
130 135
131 136
132 137 utility
133 138 The utility to be run in the specified zone.
134 139
135 140
136 141 argument...
137 142 Arguments passed to the utility.
138 143
139 144
140 145 EXIT STATUS
141 146 In interactive and non-interactive modes, the zlogin utility exits when
142 147 the command or shell in the non-global zone exits. In non-interactive
143 148 mode, the exit status of the remote program is returned as the exit
144 149 status of zlogin. In interactive mode and console login mode, the exit
145 150 status is not returned. zlogin returns a 0 exit status as long as no
146 151 connection-related error occurred.
147 152
148 153
149 154 In all modes, in the event that a connection to the zone cannot be
150 155 established, the connection fails unexpectedly, or the user is lacking
151 156 sufficient privilege to perform the requested operation, zlogin exits
152 157 with status 1.
153 158
154 159
155 160 To summarize, the following exit values are returned:
156 161
157 162 0
158 163 Successful entry.
159 164
160 165
161 166 1
162 167 Permission denied, or failure to enter the zone.
163 168
164 169
165 170 Any
166 171 Return code from utility, or from su(1M) if operating in non-
167 172 interactive mode.
168 173
169 174
170 175 ATTRIBUTES
171 176 See attributes(5) for descriptions of the following attributes:
172 177
173 178
174 179
175 180
176 181 +--------------------+-----------------+
177 182 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
178 183 +--------------------+-----------------+
179 184 |Interface Stability | Evolving |
180 185 +--------------------+-----------------+
181 186
182 187 SEE ALSO
|
↓ open down ↓ |
106 lines elided |
↑ open up ↑ |
183 188 login(1), rsh(1), vi(1), su(1M), zoneadm(1M), zonecfg(1M),
184 189 attributes(5), zones(5)
185 190
186 191 NOTES
187 192 zlogin fails if its open files or any portion of its address space
188 193 corresponds to an NFS file. This includes the executable itself or the
189 194 shared libraries.
190 195
191 196
192 197
193 - January 22, 2014 ZLOGIN(1)
198 + March 17, 2015 ZLOGIN(1)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX