=head1 NAME

B<imgexport> - Exports an xCAT image.

=head1 SYNOPSIS

B<imgexport [-h| --help]>

B<imgexport> I<image_name> [I<destination>] [B<-e>|B<--extra> I<file:dir>] ... ] [B<-p>|B<--postscripts> I<node_name>] [B<-R>|B<--remotehost> I<user@host>] [B<-v>|B<--verbose>]


=head1 DESCRIPTION

The B<imgexport> command will export an image that is being used by xCAT.  To export images, you must have the images defined in the I<osimage> table. All the columns in the I<osimage> and I<linuximage> tables will be exported. If kits are used in stateful or stateless images, I<kit>, I<kitcomponent> and I<kitrepo> tables will be exported. In addition, the following files will also be exported.

B<For stateful>:

  x.pkglist
  x.otherpkgs.pkglist
  x.tmpl
  x.synclist
  kits related files

B<For stateless>:

  kernel
  initrd.gz
  rootimg.cpio.xz or rootimg.cpio.gz or rootimg.tar.xz or rootimg.tar.gz or rootimg.gz(for backward-compatibility)
  x.pkglist
  x.otherpkgs.pkglist
  x.synclist
  x.postinstall
  x.exlist
  kits related files


B<For statelite>:

  kernel
  initrd.gz
  root image tree
  x.pkglist
  x.synclist
  x.otherpkgs.pkglist
  x.postinstall
  x.exlist

where x is the name of the profile.


Any files specified by the B<-e> flag will also be exported. If B<-p> flag is specified, the names of the postscripts and the postbootscripts for the given node will be exported. The postscripts themselves need to be manually exported using B<-e> flag.

For statelite, the litefile table settings for the image will also be exported. The litetree and statelite tables are not exported.

=head1 OPTIONS

=over 4

=item B<-e|--extra> I<srcfile:destdir>

Pack up extra files. If I<destdir> is omitted, the destination directory will be the same as the source directory.

=item B<-h|--help>

Display usage message.

=item B<-p|--postscripts> I<node_name>

Get the names of the postscripts and postbootscripts for the given node and pack them into the image.

=item B<-R|--remotehost> I<user@host>

Export the image to remote host. Passwordless ssh must be setup to the remote host.

=item B<-v|--verbose>

Verbose output.

=item I<image_name>

The name of the image. Use B<lsdef -t osimage> to find out all the image names.

=item I<destination>

The output bundle file name. If remote host is specified with B<--remotehost> option, 
the I<destination> can include the path to the bundle file. If remote host is not
specified, the bundle file is placed in a local working directory, even if I<destination>
includes a path.

=back


=head1 RETURN VALUE

0 The command completed successfully.

1 An error has occurred.

=head1 EXAMPLES

1. Simplest way to export an image.  If there is an image in the osimage table named 'foo', then run:

 imgexport foo

foo.tgz will be built in the current working directory.  Make sure that you have enough space in the directory that you are in to run imgexport, if you have a big image to tar up.

2. To include extra files with your image:

 imgexport Default_Stateless_1265981465 foo.tgz -e /install/postscripts/myscript1 -e /tmp/mydir:/usr/mydir

In addition to all the default files, this will export I</install/postscripts/myscript1> and the whole directory I</tmp/dir> into the file called foo.tgz.  And when imgimport is called  I</install/postscripts/myscript1> will be copied into the same directory and I</tmp/mydir> will be copied to I</usr/mydir>.

3. To include postscript with your image:

 imgexport Default_Stateless_1265981465 foo.tgz -p node1 -e /install/postscripts/myscript1

The I<postscripts> and the I<postbootscripts> names specified in the I<postscripts> table for node1 will be exported into the image. The postscript I<myscript1> will also be exported.

=head1 FILES

/opt/xcat/bin/imgexport


=head1 SEE ALSO

L<imgimport(1)|imgimport.1>