getimage - pull an image from a golden client

getimage [ OPTION ... ] -golden-client HOSTNAME -image IMAGENAME

This manual page documents briefly the getimage command.

getimage is a program that pulls an image to the image server. The source for this image can be either a golden client or an image stored on another image server

A summary of options is included below.

-help

Show summary of options

-version

Display version and copyright information

-golden-client HOSTNAME

Hostname or IP address of the "golden" client

-image IMAGENAME

Where IMAGENAME is the name to assign to the image you are retrieving. This can be either the name of a new image if you want to create a new image, or the name of an existing image if you want to update an image. If you are using the -server option, the same imagename is used for both the source and destination.

-ssh-user USERNAME

Username for ssh connection to the client. Only needed if a secure connection is required.

-log STRING

Quoted string for log file format. See the rsyncd.conf(5) man page for options.

-quiet

Don't ask any questions or print any output (other than errors). In this mode, no warning will be given if the image already exists on the server.

-directory PATH

The full path and directory name where you want this image to be stored. The directory bearing the image name itself will be placed inside the directory specified here.

-exclude PATH

Don't pull the contents of PATH from the golden client. PATH must be absolute (starting with a "/").

To exclude a single file use:

-exclude /DIRECTORYNAME/FILENAME

To exclude a directory and it's contents use:

-exclude /DIRECTORYNAME/

To exclude the contents of a directory, but pull the directory itself use:

-exclude "/DIRECTORYNAME/*"

-exclude-file FILE

Don't pull the PATHs specified in FILE from the golden client. See the rsync(1) for details on creating this file.

-update-script YES|NO

Update the $image.master script? Defaults to NO if -quiet. If not specified you will be prompted to confirm an update.

-no-listing

Don't show each filename as it is copied over during install. This is useful for times when your console device is slow (e.g. serial console), and is the bottleneck of your installation.

The following options affect the autoinstall client after autoinstalling.

-ip-assignment METHOD

Where METHOD can be:

•

static_dhcp -- A DHCP server will assign the same static address each time to clients installed with this image. The DHCP server in this case also assigns the corresponding host name. It is possible therefore, when using static dhcp, to change a machine's hostname and IP address by simply changing one value in the dhcpd.conf file. Some may find this desirable. Also see the mkdhcpstatic command.

•

dynamic_dhcp -- A DHCP server will assign IP addresses dynamically to clients installed with this image. In dynamic dhcp, the IP address of a machine may change, but you want it to retain the same host name. Therefore the hostname is set by the machine itself. They may be assigned a different address each time.

•

static -- The IP address the client uses during autoinstall will be permanently assigned to that client.

•

replicant -- Don't mess with the network settings in this image. I'm using it as a backup and quick restore mechanism for a single machine.

-post-install ACTION

ACTION can be:

•

beep -- Clients will beep incessantly after successful completion of an autoinstall.

•

reboot -- Clients will reboot themselves after successful completion of an autoinstall.

•

shutdown -- Clients will halt themselves after successful completion of an autoinstall.

addclients(8), mkdhcpserver(8), mkdhcpstatic(8),

More details can be found in the SystemImager manual.

This manual page was compiled by dann <<dannf@debian.org>> for the Debian GNU/Linux system (but may be used by others).