Performs a backup on the domain.


asadmin [asadmin-options] backup-domain [--help]
[--description description-text]
[--domaindir domain-root-dir]
[--backupdir backup-directory]
[--backupconfig backup-config-name]


The backup-domain subcommand backs up files under the named domain.

To complete the command, however, the domain must be stopped first. This will mean that any application deployed to the DAS is unavailable while the backup takes place.



Options for the asadmin utility. For information about these options, see the asadmin help page.


Displays the help text for the subcommand.


Displays detailed information about the backup operation.

The default value is false.


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

The default value has this form:


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

The default value is as-install/domains.


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

The default value is as-install/domains/domain-dir/backups. If the domain is not in the default location, the location is domain-dir/backups.



Specifies the name of the domain to be backed up.

This operand is optional if only one domain exists in the Payara Server installation.

Exit Status


subcommand executed successfully


error in executing the subcommand

See Also