flarcreate(1MCM)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXIT STATUS | ATTRIBUTES | SEE ALSO

NAME

flarcreate– create a flash archive from a master system

SYNOPSIS

flarcreate -n name [-R root] [-H] [-I] [-S] [-c] [-t[-p posn][-b blocksize]] [-i date] [-u section…] [-U key=value…] [-m master] [-f [filelist | -][-F]] [-a author] [-e descr | -E descr_file] [-T type] [-x exclude…] [-y include…] [-z filelist…] [-X filelist…] archive

DESCRIPTION

The flarcreate command creates a flash archive from a master system. A master system is one that contains a reference configuration, which is a particular configuration of the Solaris operating environment, plus other optional software. A flash archive is an easily transportable version of the reference configuration.

In flash terminology, a system on which an archive is created is called a master. The system image stored in the archive is deployed to systems that are called clones.

An archive contains all the files that are in a system image.

Following the creation of a flash archive, you can use custom JumpStart to clone the archive on multiple systems.

You can run flarcreate in multiuser or single-user mode. You can also use the command when the master system is booted from the first Solaris software CD or from a Solaris net image.

Archive creation should be performed when the master system is in as stable a state as possible. Following archive creation, use the flar(1MCM) command to administer a flash archive.

See flash_archive(4CM) for a description of the flash archive.

The flarcreate command requires superuser privileges.

OPTIONS

The flarcreate command has one required option:

-n name

Specifies the name of the flash archive. name is supplied as the value of the content_name keyword. See flash_archive(4CM).

The flarcreate command has the following general options:

-c

Compresses the archive using compress(1).

-f filelist

Uses the contents of filelist as a list of files to include in the archive. The files are included in addition to the usual file list, unless -F is specified (see the -F option). If filelist is -, the list is taken from standard input.

-F

Includes only files in the list specified by -f. This option makes -f filelist an absolute list, rather than a list that is appended to the usual file list.

-H

Does not generate a hash identifier.

-I

Ignores integrity check. To prevent you from excluding important system files from an archive, flarcreate runs an integrity check. This check examines all files registered in a system package database and stops archive creation if any of them are excluded. Use this option to override this integrity check.

-R root

Creates the archive from the file system tree mounted at root. If you do not specify this option, flarcreate creates an archive from a file system mounted at /.

-S

Skips the disk space check. Without -S, flarcreate builds a compressed archive in memory before writing the archive to disk, to ensure you have sufficient disk space. Use -S to skip this step. The result of the use of -S is a significant decrease in the time it takes to create an archive.

-U key=value...

Includes one or more user-defined keywords and their values in the archive identification section. See flash_archive(4CM).

-x exclude...

Excludes the file or directory exclude from the archive. Note that the exclude file or directory is assumed to be relative to the alternate root specified using -R. If the parent directory of the file exclude is included with the -y option (see -y include), then only the specific file or directory specified by exclude is excluded. Conversely, if the parent directory of an included file is specified for exclusion, then only the file include is included. For example, if you specify:

-x /a -y /a/b

all of /a except for /a/b is excluded. If you specify:

-y /a -x /a/b

all of /a except for /a/b is included.

-X filelist...

Uses the contents of filelist as a list of files to exclude from the archive. If filelist is –, the list is taken from standard input.

-y include...

Includes the file or directory include in the archive. Note that the exclude file or directory is assumed to be relative to the alternate root specified using -R. See the description of the -x option for a description of the interaction of the -x and -y options.

-z filelist...

Is a list of files prefixed with a plus (+) or minus (-). A plus indicates that a file should be included in the archive. The minus indicates exclusion. If filelist is –, the list is taken from standard input.

Use the following options with user-defined sections:

-d dir

Retrieves the section file specified with -u from dir.

-u section...

Includes the user-defined section located in the file section in the archive. section must be a blank-separated list of section names as described in flash_archive(4CM).

Use the following options with tape archives:

-b blocksize

Is the block size to be used when creating the archive. If not specified, a default block size of 64K is used.

-p posn

Used only with -t. Specifies the position on the tape device where the archive should be created. If not specified, the current position of the tape device is used.

-t

Creates an archive on a tape device. The archive operand (see OPERANDS) is assumed to be the name of the tape device.

The following options are used for archive identification:

-a author

Provides an author name for the archive identification section. If you do not specify -a, no author name is included in the identification section.

-e descr

Is the description to be included in the archive as the value of the content_description archive identification key. This option is incompatible with -E.

-E descr_file

Is the description to be used as the value of the archive identification content_description key as retrieved from the file descr_file. This option is incompatible with -e.

-i date

By default, the value for the creation_date field in the identification section is generated automatically, based on the current system time and date. If you specify the -i option, date is used instead.

-m master

By default, the value for the creation_master field in the identification section is the name of the system on which you run flarcreate, as reported by uname -n. If you specify -m, master is used instead.

-T type

Is the content type included in the archive as the value of the content_type archive identification key. If you do not specify -T, the content_type keyword is not included.

OPERANDS

The following operand is supported:

archive

Path to tape device if the -t option was used. Otherwise, the complete path name of a flash archive. A file containing a flash archive has a standard file extension of .flar.

EXIT STATUS

The following exit values are returned:

0

Successful completion.

0

An error occurred.

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWinst

SEE ALSO

compress(1), flar(1MCM), flash_archive(4CM), attributes(5)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXIT STATUS | ATTRIBUTES | SEE ALSO