In this chapter
The options in this chapter are common to backup, restore, verify and copy jobs. In most cases these settings can be left at their default values.
Yosemite Server Backup keeps a log of which files it processes while running a job. In addition to viewing the job log from the Status and Logs view, you can configure the job to e-mail it automatically to a designated e-mail address or save the log to a file for later viewing.
Yosemite Server Backup has several different levels of logging control to communicate what was protected in a job.
Log only failed (default) This setting will log only files that could not be backed up because of some failure.
Log only failed and not attempted This setting is log files that could not be backed up because of a failure or because the machine hosting the file was offline or because the job was cancelled.
Log only completed This setting logs only the files that were successfully protected.
Log all This setting will log all files the job works on. Using this setting will generate a lot of log entries and can affect the length of the backup process.
None This setting is not recommended. However, using it can speed up the backup process.
Yosemite Server Backup can generate several file types. Select the log format that works best for you
Table: Log file formats
| Format | Description |
|---|---|
| HTML | Choose this file type to save log files as fully formatted HTML files. These files can be read by most Internet browsers. |
| XML | Choose this file to save the log files as well-formed XML documents. These files can be read by most Internet browsers. |
| Excel CSV | Choose this file type to save the log files in a format that can be opened in Microsoft Excel. CSV stands for Comma Separated Value. The information saved to a file formatted for Excel CSV will display in columns and rows. |
| Plain Text | Choose this file type to save the log files in a format that can be read by any text editor. |
Log Format Choose a format from the drop down list.
Log will be saved to this file Yosemite Server Backup lets you select a file in which to store the job logs. Click the Browse button to select a file. Yosemite Server Backup always saves a copy of the log in the catalog in addition to the settings you choose here.
Log Format Choose a format from the drop down list.
Log will be sent to... Yosemite Server Backup lets you e-mail logs to one or more recipients. Enter a list of recipients separated by semicolons.
In some cases, you may want positive confirmation that an object — like a database — was backed up but you don't want to wade through the log file generated by selecting Log All. You can accomplish this by setting the Audit property on the object when you select if for backup. Simply locate the object in the Selection page of the job properties, right-click on the object and select Properties, and check the Enable Audit box on the property page. By default, all Exchange and SQL databases are audited.
You can define commands to be executed before the backup job runs and after the backup job runs. They are often used to perform custom OS-specific or application-specific tasks, such as to stop/start a database. Commands are defined on the Execution page of a backup job.
The pre execution tab on jobs controls the command to be executed before the job is run, either on multiple hosts, or just the Domain Server. In addition there are options to control whether the job should stop, or whether the job should continue based on the outcome of the command.
Command path Specifies a full path or relative path, to a shell command, including command parameters. For instance cmd.exe /c explorer.exe, or c:\windows\explorer.exe. A macro syntax is also supported in this field, for many different uses. See the Yosemite Server Backup Technical Reference Guide for more information.
Run command on all hosts selected in job, as well as the Domain Server When checked, processes the command on all machines selected in job. When unchecked, only runs the command on the Domain Server.
Number of minutes to wait for command completion This value in minutes specifies how long the application should wait for the command to return. By default, it is set to Forever, meaning the application will wait for as long as possible for the command to complete. If set to something other then Forever, the application will terminate the command forcefully if it does not return in time.
Stop job if command fails to be executed When checked, causes the job to be stopped if the pre command is fails to be executed, such as if the command does not exist or the operating system cannot property determine how to execute the command.
Stop job if command returns error code When checked, causes the job to be stopped if the pre command executes but returns a non-zero code. When checked, enables the additional options beneath it.
Do not stop job if the following error code range is returned When checked, a range of error codes must be specified which are treated as warnings. If the return code is zero or is within the specified range, the job continues. However, if the return code is non-zero and outside of the specified range, the job to be stopped.
The post execution job property controls what shell commands should be executed after the job completes with no error or with error.
Command to execute if job completes with no error This command will execute if the job completes with no final error. A job can complete with no error, even if all hosts are offline. This does not mean that anything was backed up, it just means that the job was not cancelled, or there wasn't some other major problem executing the job.
Command to execute if job completes with error This command will execute if the job completes with an error, such as no specified devices, or operator cancelled. This does not mean if any of the objects selected by the job fail to be backed up/restored/ or verified.
Command path Specifies a full path or relative path, to a shell command, including command parameters. For instance cmd.exe /c explorer.exe or c:\windows\explorer.exe. A macro syntax is also supported in this field, for many different uses. See the Yosemite Server Backup Technical Reference Guide for more information.
Run command on all hosts selected in job, as well as the Domain Server When checked, processes the command on all machines selected in job. When unchecked, only runs the command on the Domain Server.
Number of minutes to wait for command completion This value in minutes specifies how long the application should wait for the command to return. By default, it is set to Forever, meaning the application will wait for as long as possible for the command to complete. If set to something other than Forever, the application will terminate the command forcefully if it does not return in time.
The pre/post commands add detailed logs to the jobs which executed them. A new execution section was added to the job log, where all commands executed by the job are logged.
Command type: Indicates what kind of command this was, whether a pre job/post job/fail job, or pre object/post object/fail object command.
Command path: The fully macro expanded command path sent to the operating system for execution.
Host attempted on: The host name where the command was attempted on.
Time executed: The start time when the command was attempted.
Time completed: The end time when the command either timed out and was killed, or when it completed on its own accord.
Execution result: The result of the execution, either the execution failed, or the execution succeeded. If the execution succeeded, then the return code of the command will be logged here. If no return code is logged, then success is logged here.
Many tape libraries support the use of barcodes to identify media. Each piece of physical media has a unique barcode that the tape library can read.
The Barcode Filter page allows you to define barcode filters for a job. The filter rules may be set for the whole domain and will be applied automatically to all jobs. Or, they may be set and applied at job level, using this page. Any filter rules applied at job level overwrite the default domain settings. All options will be grayed out initially. Deselecting Inherit settings from domain will enable the editing buttons and allow you to create job-specific filters.
There are three ways of assigning barcode filters.
Add an individual barcode This option allows you to specify an individual barcode for inclusion or exclusion. Up to 8 characters may be specified in this filter; the first 6 relate to the volume identifier and the last 2 relate to the media identifier. Wildcards may be used to increase the number of barcodes selected by the filter.
Add a range of barcodes This filter allows you to specify a range of volume identifiers and media identifiers to include. (Any media without a barcode or outside of the specified range will be excluded.) The following example would include LTO-3 (L3) media that fall within the volume range 791000 to 791044.
Add barcodes from media present in the library This filter displays a list of all libraries and their elements. Select the required barcodes from the list and click either the Exclude or the Include button, as appropriate.