This manual page is for Mac OS X Server version 10.6

If you are running Mac OS X (client), this command is not available.

If you are running a different version of Mac OS X Server, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.


ServerBackup(1)                          BSD General Commands Manual                         ServerBackup(1)

NAME
     ServerBackup

SYNOPSIS
     ServerBackup [-cmd -path -source -target -service -opt]

DESCRIPTION
     ServerBackup is the main program that will perform actions supported by the Server Backup (
     ServerBackup ).  ServerBackup supports the following options:

     /usr/sbin/ServerBackup -cmd backup -source SOURCE_VOLUME
                                    Will start the backup process for the
                                    supplied SOURCE_VOLUME.  This should
                                    always be / for Server.  e.g.; /usr/sbin/ServerBackup -cmd backup
     -source /
                                    Note: the SOURCE_VOLUME for backup
                                    must be at version 1060 or later.

     /usr/sbin/ServerBackup -cmd browse -path PATH -service SERVICE -opt OPT
                                    Will obtain browse listing of service.
                                    SERVICE can be specified as
                                    [all] to get all service browsable items.  e.g.; /usr/sbin/ServerBackup
     -cmd browse -path /xxx -service sharePoints

     /usr/sbin/ServerBackup -cmd postBackupComplete
                                    Removes the .ServerBackups folder from the
                                    boot drive.

     /usr/sbin/ServerBackup -cmd prefs
                                    Show current settings for ServerAdmin
                                    backup.

     /usr/sbin/ServerBackup -cmd purgeSnapShot -path xxx
                                    Will remove a snapshot at the path xxx.
                                    Since data could be removed
                                    this should be used with care.
                                    Use with care!!!

     /usr/sbin/ServerBackup -cmd restore -path PATH -target DESTINATION_VOLUME
                                    Will start the restore process with
                                    the supplied PATH for the indicated
                                    DESTINATION_VOLUME.  Note: the
                                    DESTINATION_VOLUME is always / e.g.; /usr/sbin/ServerBackup -cmd restore
     -path /xxxe -target /
                                    Since data could be overwritten
                                    this should be used with care.  Also,
                                    any special service handling should
                                    be considered!!!
                                    Use with care!!!
                                    Note: the DESTINATION_VOLUME for restore
                                    must be server version 1060 or later.

     /usr/sbin/ServerBackup -cmd restoreService -path PATH -target DESTINATION_VOLUME -service SERVICE -opt
     all
                                    Will start the restore process with
                                    the supplied PATH for the indicated
                                    DESTINATION_VOLUME and the indicated
                                    service SERVICE.
                                    Note: the DESTINATION_VOLUME is always / e.g.; /usr/sbin/ServerBackup
     -cmd restoreService -path xxx -target / -service serverSettings

                                    Since data could be overwritten
                                    this should be used with care.
                                    Also, any special service handling
                                    should be considered!!!
                                    Use with care!!!
                                    Note: the DESTINATION_VOLUME for restore must be server version $MINVER
     or later.

     /usr/sbin/ServerBackup -cmd services
                                    Lists the names of services.

     /usr/sbin/ServerBackup -cmd size  Calculates the size requirements for
                                    doing a backup.
                                    The line returned represents the number
                                    of Kilobytes required for storage.  e.g.; total := 1872

     /usr/sbin/ServerBackup -cmd version
                                    Returns version information for
                                    this binary.  e.g.; Server Backup (ServerBackup), Apple Inc., Version
     10.6

     /usr/sbin/ServerBackup -cmd verify -path PATH -service SERVICE -opt log | image
                                    Will verify the data using the log file for that service.  e.g.;
     /ServerBackup -cmd verify -path /xxx -service sharePoints

     Server Backup (ServerBackup), Apple Inc., Version 10.6

FILES
     /usr/sbin/ServerBackup                        Main program

Darwin                                        October 15, 2009                                        Darwin

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.