System Administration Commands virt-install(1M) NAME - virt-install - install guest operating system on xVM system + virt-install - install guest operating system on xVM hypervisor SYNOPSIS /usr/bin/virt-install [options] DESCRIPTION The virt-install program enables you to install a guest - operating system on a machine running Solaris xVM. + operating system on a machine running on the xVM hypervisor. virt-install allows you to enter information about a guest either as a set of command-line options or in response to a - series of prompts. + series of prompts: - When run without options, virt-install - takes you through a series of prompts, for which you need to - know the information listed below. This information maps to - the command options, described in their own section. o Name of your guest domain. This name serves as the label of the guest operating system and will be the name of the file that stores the guest's configura- tion. For network-based installs, the name of the domain must match its real hostname. o Amount of RAM to be allocated to the guest, in MB. Solaris domains should use 512MB minimum. o Path to the disk image of the guest. This path is exported as an entire disk to your guest. It is on the xVM control domain and can be to a physical disk, a flat file, or any device that provides a block device interface; for example, a ZFS volume or a Solaris Volume Manager volume. o If the path specified in the preceding bullet does not already exist, the size, in GB, of the virtual disk for your guest. o You must choose whether to enable graphics support for the domain. Note that paravirtualized Solaris domains do not currently support a graphical con- sole in this manner. o URI for the location of the installation software. This can be an NFS path, or the path to a local directory or ISO. Some operating systems do not yet support ISO installs. Some operating systems require that the install host be fully qualified (for example, my.nfs.server.com) for the install to work. Examples of acceptable installation paths are: SunOS 5.11 Last change: 11 Feb 2009 1 System Administration Commands virt-install(1M) nfs:my.nfs.server.com:/home/install/test/tree /export/solarisdvd.iso After entering required information, installation starts. If you enabled graphics, a Virtual Network Computing (VNC) win- dow opens and presents the graphical installer. If graphics - are not enabled, the text installer displays. + are not enabled, the text installer is displayed. You can connect to the graphical console by finding the correct display with the command: % virsh vncdisplay dom-name ...and then running: % vncviewer localhost:d ...where d is the display returned by the preceding virsh vncdisplay command. Autoconfiguration data (see the --autocf option, below) is presented to the guest as a floppy device. For Solaris, this can be a UFS or PCFS file system image containing sysidcfg(4) and Jumpstart profile data. To run virt-install, you must become superuser or assume the Primary Administrator role. OPTIONS The following options are supported: --autocf=location Specifies location of autoconfiguration data for the guest. For fully virtualized guests installing from an ISO file or DVD, location specifies the pathname of a disk image to be presented to the guest as the floppy device fda. The following is the path to a local filename containing SunOS 5.11 Last change: 11 Feb 2009 2 System Administration Commands virt-install(1M) a floppy image: /path/to/guest/autocf.img This option is ignored for fully virtualized guests ins- talling over a network using PXE. Such a guest will retrieve any autoconfiguration data over the network. For paravirtualized guests, support for this option is guest-specific. For Solaris paravirtualized guests installing over NFS, this option allows you to specify the NFS pathname to a directory containing a sysidcfg(4) file along with a Solaris Jumpstart profile. The following is the path to a NFS directory containing Solaris autoconfiguration data: nfs:netinstall:/export/guests/guest.autocf -b bridge, --bridge=bridge Bridge to which to connect the network interface. If you do not specify a bridge, the system attempts to deter- mine the default. This should be the name of the inter- face in the control domain through which to route the domain's networking traffic, for example, bge0. -c cdrom, --cdrom=cdrom File to use as a virtual CD-ROM device for fully virtu- alized guests. This option works with HVM domains and is ignored with paravirtualized domains. It can be path to an ISO image, or to a CD-ROM device. It can also be a URL from which to fetch or access a minimal boot ISO image. The URLs take the same format as described for the --location argument. If this option is omitted then either the --location argument must be entered, to specify a location for the kernel and initrd, or the -- pxe option used, to install from the network. --check-cpu Check that VCPUs do not exceed physical CPUs and warn if they do. SunOS 5.11 Last change: 11 Feb 2009 3 System Administration Commands virt-install(1M) --connect=URI Connect to hypervisor at URI. --cpuset=cpuset Specify which physical CPUs the guest can use. cpuset is a comma-separated list of numbers, which can be speci- fied in ranges. For example: 0,2,3,5 Use processors 0, 2, 3, and 5 1-3,5,6-8 Use processors 1, 2, 3, 5, 6, 7, and 8 -d, --debug Display debugging information. The debugging information is stored in $HOME/.virtinst/virt-install.log, even if this option is omitted. In this path, $HOME is the home directory of the user invoking virt-install, such as / or /root. + --disk path=... [options] + + Specify a disk to attach to the guest domain. This is a + comma-separated list of options, which must start with + the "path" argument. For example: + + --disk path=/guest/root.img,sparse=true + + The available argument and options are: + + path=... + + Path to the file, disk partition, or logical volume + to use as the backing store for the guest's virtual + disk. + + perms=ro + + The disk should be read-only. + + device=disk|cdrom|floppy + + The disk should be presented as a normal hard disk, + CD-ROM, or floppy disk. + + size=... + + Size of the disk in Gb, if it does not yet exist. + + sparse=true|false + + Where appropriate, mark the disk as sparse or + fully-allocated. + + This option does not work with the -w network option + (see below) on Solaris xVM. + -f pathname, --file=pathname Path to the file, disk partition, or logical volume to use as the backing store for the guest's virtual disk. If the path does not exist, then --file-size option should also be specified, allowing the disk to be created. -h, --help Display list of virt-install options. SunOS 5.11 Last change: 11 Feb 2009 4 System Administration Commands virt-install(1M) -k keymap, --keymap=keymap Request that the virtual console be configured to run with a non-English keyboard layout. -l location, --location=location Installation source for paravirtualized guest. Fully virtualized guests must use either --location to specify a kernel and initrd or the --cdrom option to specify an ISO/CDROM image. The location argument can take the forms, nfs:host:/path, or a file system path in the con- trol domain, as described above. + --livecd + + Treat the CD-ROM media as a live CD. -m mac_addr, --mac=mac_addr Specifies a fixed MAC address for the guest. If this parameter is omitted, or the value random is specified, a suitable address will be randomly generated. For xVM virtual machines it is required that the first 3 pairs in the MAC address be the sequence 00:16:3e. This option is required when performing PXE or NFS-based installa- tions of Solaris guests. -n name, --name=name Name of the new guest virtual machine instance. This must be unique among all guests known to the hypervisor on this machine, including those not currently active. --noacpi Disables Advanced Configuration and Power Interface (ACPI) for fully virtualized guest. Overrides configura- tion setting stored in systems specified by --os-type and --os-variant options. --noapic Disables Advanced Programmable Interrupt Controller (APIC) for fully virtualized guest. Overrides configura- tion setting stored in systems specified by --os-type and --os-variant options. --noautoconsole SunOS 5.11 Last change: 11 Feb 2009 5 System Administration Commands virt-install(1M) Do not automatically try to connect to the guest con- sole. The default behavior is to launch a VNC client to display the graphical console, or to run the virsh con- sole command to display the text console. Use of this option disables this behavior. --nodisks Request a virtual machine without any local disk storage, typically used for running "Live CD" images or installing to network storage (iSCSI or NFS root). This disables all interactive prompts for disk setup. --nographics Disable all interactive prompts for the guest virtual console. No graphical console will be allocated for the guest. A text-based console will always be available on the first serial port (or equivalent paravirtualised console device). + --nonetworks + + Do not create network interfaces for the guest. --nonsparse Request creation of a non-sparse file for the guest vir- tual disk. Note that use of this option causes guest creation to be significantly slower than otherwise. + --noreboot + + Do not automatically reboot the guest domain after the first + stage of installation. --os-type=os_type Optimize the guest configuration for a type of operating system. This option attempts to pick the most suitable ACPI and APIC settings, select optimally supported mouse drivers, and generally accommodate other operating sys- tem peculiarities. See "OS Types and OS Variants", below for a list of acceptable values. For optimal guest operating system performance, you should specify the --os-type and --os-variant options. --os-variant=os_variant The OS variant for fully virtualized guests. See "OS Types and OS Variants", below for a list of acceptable values. For optimal guest operating system performance, you should specify the --os-type and --os-variant options. SunOS 5.11 Last change: 11 Feb 2009 6 System Administration Commands virt-install(1M) -p, --paravirt Indicates that guest is paravirtualized. If the host supports both paravirtualization and full virtualiza- tion, and neither this parameter nor the --hvm option are specified, this will be prompted for interactively. --pxe Use the PXE boot protocol to load the initial ramdisk and kernel for starting the guest installation process. If this option is omitted, then either the --location or --cdrom options must be entered, to specify a location for the kernel and initrd. -r mem_amount, --ram=mem_amount Memory to allocate for guest instance, in megabytes. -s disksize, --file-size=disksize Size of the file to create for the guest virtual disk, if the path specified with the --file does not already exist. The filesize is specified in gigabytes, with fractional numbers allowed. The storage for the file will not be pre-allocated unless the --nonsparse option is also specified. --sdl Use Simple DirectMedia Layer (SDL) for graphics support. This option works with some guest domains, including HVM, but not with Solaris. + --sound + + Use sound device emulation. Does not work on Solaris xVM. -u UUID, --uuid=UUID Specifies UUID, as a 32-digit hexadecimal number, for the guest. if no UUID is specified, the system generates a random UUID. If you enter a UUID, keep in mind that it is intended to be a globally unique value. -v, --hvm Specifies that the guest is a Hardware-assisted Virtual Machine (HVM). Requests the use of full virtualization, if both paravirtualization and full virtualization are available on the host. This parameter might not be available if connecting to a hypervisor on a machine without hardware virtualization support. SunOS 5.11 Last change: 11 Feb 2009 7 System Administration Commands virt-install(1M) This guest should be fully virtualized. --vcpus=vcpus Number of Virtual (VCPUs) to configure for your guest. --vnc Use Virtual Network Computing (VNC) for graphics sup- port. This option works with HVM domains but not with paravirtualized domains. Unless the --vncport parameter is also provided, the VNC server will run on the first free port number at 5900 or above. The actual VNC display allocated can be obtained using the vncdisplay subcommand to virsh(1M). --vncport=vncport Request a permanent, statically assigned port number for the guest VNC console. Use of this option is discouraged as another guest might automatically choose to run on the specified port, creating a conflict. -w network, --network=network Connect the guest to the host network. The value for network can take the following format: host:bridge Connect to a bridge device in the specified host. Use this option if the host has a static networking configuration and the guest requires full outbound and inbound connectivity with the LAN. Also use this format if live migration will be used with this guest. If this option is omitted, a single NIC will be created in the guest. If there is a bridge device in the host with a physical interface enslaved, this interface will be used for connectivity. Failing that, the virtual net- work called default will be used. This option can be specified multiple times to setup more than one NIC. + --wait=num_minutes + + Wait for num_minutes minutes for installation to complete. + If a VNC viewer could not be launched for a graphical + installation, this option defaults to waiting indefinitely + if the OS needs to reboot during installation (e.g. Windows). + -1 means wait forever. -x extra_args, --extra-args=extra_args When installing paravirtualized guests, specifies SunOS 5.11 Last change: 11 Feb 2009 8 System Administration Commands virt-install(1M) additional arguments to pass to the installer. OS Types and OS Variants The following are the valid OS type and OS variant values for --os-type and --os-variant options described above. os-type os-variant ------- ---------- linux (Linux 2.x series) rhel2.1 rhel3 rhel4 rhel5 fedora5 fedora6 fedora7 fedora8 + fedora9 + fedora10 + ubuntuhardy sles10 debianEtch debianLenny generic24 generic26 windows (Microsoft Windows 9x or later) winxp + winxp64 win2k win2k3 + win2k8 vista unix (Traditional UNIX BSD or SysV derivatives) freebsd6 + freebsd7 openbsd4 solaris (Solaris 9 or later) solaris9 solaris10 opensolaris other (Not in one of groups above) msdos netware4 netware5 netware6 generic + For Windows 7, use vista. EXAMPLES Example 1 Installing Solaris onto a Local Disk from an ISO SunOS 5.11 Last change: 11 Feb 2009 9