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