2.4.1 backup-domain

Synopsis

asadmin [asadmin-options] backup-domain [--help]
    [--long[={false|true}]] [--description description-text]
    [--domaindir domain-root-dir] [--backupdir backup-directory]
    [domain_name]

Storage location

Application Server installation directory/javaee/glassfish/bin

Function

The backup-domain subcommand creates a backup of the files in a named domain.

This command is supported in local mode only in Application Server. In Application Server, the domain to be backed up must be stopped.

Precondition

The domain to be backed up must be stopped.

Files

When the backup-domain subcommand is executed, a ZIP archive file, containing all the files of the domain being backed up, is created in the folder specified by the --backupdir option of this command.

Arguments

--help | -?

Displays the help text for the subcommand.

--long[={false|true}] | -l

Displays detailed information about the backup operation.

Type: Boolean

The following values can be specified:

• true

  Displays detail information.

• false

  Does not display detail information.

Default value: false

--description description-text

Specifies a description to store in the backup file. The description is displayed as part of the information about a backup file.

Type: String

The following values can be specified:

• Text describing the backup

Default value: Displays the default value in the following format:

domain-name backup created on YYYY_MM_DD by user user-name

--domaindir domain-root-dir

Specifies the domain root directory, the parent directory of the domain to back up.

Type: String

The following values can be specified:

• Specify the domain directory path

Default value: Application Server installation directory/javaee/glassfish/domains

--backupdir backup-directory

Specifies the directory under which the backup file is to be stored.

Type: String

The following values can be specified:

• File path for backup

Default value: domain-dir/backups

domain_name

Specifies the name of the domain to be backed up.

Type: String

The following values can be specified:

• Name of a domain

Default value: N/A

asadmin backup-domain --backupdir /net/backups.example.com/glassfish 
domain1

Exit Status

Exit Status	Explanation
0	command executed successfully.
1	error in executing the command.