zlogin man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

ZLOGIN(1)							     ZLOGIN(1)

NAME
       zlogin - enter a zone

SYNOPSIS
       zlogin [-CEQ] [-e c] [-l username] zonename

       zlogin [-nEQS] [-e c] [-l username] zonename utility
	    [argument]...

DESCRIPTION
       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, zlo‐
			       gin invokes  login(1)  to  provide  a  suitable
			       login session.

       Non-Interactive Mode
			       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).

       Console Mode
			       If the -C option is specified, the user is con‐
			       nected  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  persis‐
			       tent across reboot of the zone.

OPTIONS
       The following options are supported:

       -C
		      Connects to the zone console.

       -e c
		      Specifies	 a  different escape character, c, for the key
		      sequence used to access extended functions and  to  dis‐
		      connect  from the login. The default escape character is
		      the tilde (~).

       -E
		      Disables the ability to access extended functions or  to
		      disconnect  from	the login by using the escape sequence
		      character.

       -l username
		      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 spec‐
		      ified.

       -n
		      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.

       -Q
		      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.

       -S
		      "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.

   Escape Sequences
       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.

SECURITY
       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.

OPERANDS
       The following operands are supported:

       zonename
		      The name of the zone to be entered.

       utility
		      The utility to be run in the specified zone.

       argument...
		      Arguments passed to the utility.

EXIT STATUS
       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.

       1
	      Permission denied, or failure to enter the zone.

       Any
	      Return  code  from  utility, or from su(1M) if operating in non-
	      interactive mode.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       ┌────────────────────┬─────────────────┐
       │  ATTRIBUTE TYPE    │ ATTRIBUTE VALUE │
       ├────────────────────┼─────────────────┤
       │Interface Stability │ Evolving	      │
       └────────────────────┴─────────────────┘

SEE ALSO
       login(1),   rsh(1),   vi(1),    su(1M),	  zoneadm(1M),	  zonecfg(1M),
       attributes(5), zones(5)

NOTES
       zlogin fails if its open files or any portion of its address space cor‐
       responds to an NFS file. This includes the  executable  itself  or  the
       shared libraries.

				 Jan 22, 2014			     ZLOGIN(1)
[top]

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net