Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
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. 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 the fields enclosed by
brackets "[]" replaced with your own identifying information:
Portions Copyright [yyyy] [name of copyright owner]
Copyright 2013 DEY Storage Systems, Inc.
Copyright (c) 2014 Gary Mills
Copyright 2015 Nexenta Systems, Inc. All rights reserved.
zlogin [-dCEQ] [-e c] [-l username] zonename
zlogin [-nEQS] [-e c] [-l username] zonename utility [argument]...
The zlogin utility is used by the administrator to enter an operating system zone. Only a superuser operating in the global system zone can use this utility.
zlogin operates in one of three modes: Interactive Mode
If no utility argument is given and the stdin file descriptor for the zlogin process is a tty device, zlogin operates in interactive mode. In this mode, zlogin creates a new pseudo terminal for use within the login session. Programs requiring a tty device, for example, vi(1), work properly in this mode. In this mode, zlogin invokes login(1) to provide a suitable login session.
If a utility is specified, zlogin operates in non-interactive mode. This mode can be useful for script authors since stdin, stdout, and stderr are preserved and the exit status of utility is returned upon termination. In this mode, zlogin invokes su(1M) in order to set up the user's environment and to provide a login environment. The specified command is passed as a string and interpreted by a shell running in the non-global zone. See rsh(1).
If the -C option is specified, the user is connected to the zone console device and zlogin operates in console mode. The zone console is available once the zone is in the installed state. Connections to the console are persistent across reboot of the zone.
The following options are supported: -C
Connects to the zone console.
Disconnect from the console when the zone halts. This option may only be used if the -C option is specified.
Specifies a different escape character, c, for the key sequence used to access extended functions and to disconnect from the login. The default escape character is the tilde (~).
Disables the ability to access extended functions or to disconnect from the login by using the escape sequence character.
Specifies a different username for the zone login. If you do not use this option, the zone username used is "root". This option is invalid if the -C option is specified.
Redirect the input of zlogin to /dev/null. This option is useful when the command running in the local zone and the shell which invokes zlogin both read from standard input.
Specifies quiet mode operation. In quiet mode, extra messages indicating the the function of zlogin will not be displayed, giving the possibility to present the appearance that the command is running locally rather than in another zone.
"Safe" login mode. zlogin does minimal processing and does not invoke login(1) or su(1M). The -S option can not be used if a username is specified through the -l option, and cannot be used with console logins. This mode should only be used to recover a damaged zone when other forms of login have become impossible.
Lines that you type that start with the tilde character (~) are "escape sequences". The escape character can be changed using the -e option. ~.
Disconnects from the zone. This is not the same as a logout, because the local host breaks the connection with no warning to the zone's end.
Once a process has been placed in a zone other than the global zone, the process cannot change zone again, nor can any of its children.
The following operands are supported: zonename
The name of the zone to be entered.
The utility to be run in the specified zone.
Arguments passed to the utility.
In interactive and non-interactive modes, the zlogin utility exits when the command or shell in the non-global zone exits. In non-interactive mode, the exit status of the remote program is returned as the exit status of zlogin. In interactive mode and console login mode, the exit status is not returned. zlogin returns a 0 exit status as long as no connection-related error occurred.
In all modes, in the event that a connection to the zone cannot be established, the connection fails unexpectedly, or the user is lacking sufficient privilege to perform the requested operation, zlogin exits with status 1.
To summarize, the following exit values are returned: 0
Successful entry.
Permission denied, or failure to enter the zone.
Return code from utility, or from su(1M) if operating in non-interactive mode.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Evolving |
login(1), rsh(1), vi(1), su(1M), zoneadm(1M), zonecfg(1M), attributes(5), zones(5)
zlogin fails if its open files or any portion of its address space corresponds to an NFS file. This includes the executable itself or the shared libraries.