Dell NetWorker 19.9 Administration Guide

PDF

Controlling exit status reporting for a custom backup script

Use the Job control attribute on the Apps & Modules tab of the Client Properties dialog box for a Client resource to control how end of job and exit status messages are determined for a custom backup script.

To access the Job control attribute, select View > Diagnostic Mode in the Administration interface to enable diagnostic mode view. A checkmark next to Diagnostic Mode in the View menu indicates that diagnostic mode view is enabled.

There are three check boxes for the Job control attribute:

end on job end
end on process exit
use process exit code

The following table provides details on exit status reporting depending on the selection of one or more of the checkboxes.

Table 1. Job control attribute selections
Selections	Description
No selections (default behavior)	The nsrpolicy and nsrjobd programs determine the success or failure of a custom script based on the completion of the save program (end of job). The following criteria apply: If the save job completion status is success, then nsrpolicy and nsrjobd report that the custom backup job succeeded. If the save job completion status is failure, then nsrpolicy and nsrjobd report that the custom backup job failed. If no completion status is received, the custom job output is examined for completed `savetime=savetime` lines. If found and the `savetime` is a value other than `0` (zero), then the custom backup job is considered to have succeeded. If the value is `0`, then the custom backup job is considered to have failed. The exit code of the custom script process is not taken into consideration.
end on job end only	A backup job is considered to be ended as soon as an end job message is received from the save command. Select this option when you do not want to wait for the postprocessing commands of the script to end.
end on process exit only	A backup job is considered to be ended as soon as the started process exits. Background processes started by the backup command could still be running on the client. Use this option when you want the custom script to start background processes and you do not want savegrp or nsrjobd to wait for the processes to complete.
use process exit code only	Only the process exit code is used to determine the success or failure of the job. An exit code of `0` indicates success. Otherwise, the job is reported as failed. Use this option when you want the script postprocessing command status to have an impact on the status of the save backup command without having to unset the NSR_STD_MSG_FD environment variable. If the script invokes more than one NetWorker backup command such as save, then you must still unset the NSR_STD_MSG_FD environment variable.
Both end on job end and end on process exit	Either event can trigger the end of a job.
Both end on job end and  use process exit code	If an end job message is received before the process exits, then the exit status provided by the end job message is used to determine the success or failure of the job.