Starts the backup operation of the Archive utility.
Backup operations create an archive directory from an existing directory. The archive directory has the same name as the original directory, but with a timestamp appended to the end. The timestamp reflects the time when the backup operation was performed.
For example, if the original directory is called logs and was backed up on October 11, 2008 at 8:00 AM, the backup operation creates a directory called logs.2008_10_11.08_00_00.
Note
Do not start a backup or rollback operation while another such operation is in progress on the same directory. Unexpected behavior may occur if you do so.
RunBackupType parameters:
token identifies the token used to stop the utility or to get its status. If you do not specify a token, one is generated and returned when you start the utility.
hostID is a unique identifier for the host. The hostID and dirName parameters specify the path to the directory that will be archived.
dirName is the full path of the directory. The hostID and dirName parameters specify the path to the directory that will be archived.
numBackups specifies the maximum number of archives to store. This number does not include the original directory itself, so if numBackups is set to 3, you would have the original directory plus up to three archive directories, for a total of as many as four directories. The default numBackups is 5.
Throws:
Returns:
