MMBACKUP_PROGRESS_CALLOUT environment variable

The MMBACKUP_PROGRESS_CALLOUT environment variable specifies the path to a program or script to be called during mmbackup execution with a formatted argument.

The $progressCallOut function is executed if the path $progressCallOut names a valid, executable file and one of the following is true:
  • The message class provided with this message is 0.

    Or

  • At least $progressInterval seconds has elapsed.

    Or

  • The $progressContent mask has a bit set which matches a bit set in the message class provided with this message.
Start of changeThe $progressCallOut function is executed during mmbackup with a single argument consisting of the following colon-separated values:Start of change
"$JOB:$FS:$SERVER:$NODENAME:$PHASE:$BCKFILES:$CHGFILES:$EXPFILES:\
$FILESBACKEDUP:$FILESEXPIRED:$ERRORS:$TIME:$TOTALSIZE:$SIZEBACKEDUP"
End of change Where:
JOB
Specifies the literal backup string to identify this component.
FS
Specifies the file system device name.
SERVER
Specifies the IBM Storage Protect server currently used for backup.
NODENAME
Specifies the name of the node where mmbackup was started.
PHASE
Specifies either synchronizing, scanning, selecting files, expiring, backing up, analyzing, or finishing.
BCKFILES
Specifies the total number of files already backed up, or stored, on the IBM Storage Protect server. Starts as the count of all normal mode records in all the current shadow databases in use. If QUERY is being executed, it will start as the count of files found on the IBM Storage Protect server. It will stay constant until the backup job is complete.
CHGFILES
Specifies the number of changed files. This value starts as 0 and changes to the total number of changed files destined for the current server, and then stays at that value.
EXPFILES
Specifies the number of expired files. This value starts as 0 and changes to the total number of files marked for expiration at the current server, and then stays at that value.
FILESBACKEDUP
Specifies the number of files that were backed up during this backup job. This value remains 0 until phase backing up is reached, and then it increases until dsmc finishes. This value increases while dsmc selective jobs are running and is calculated by IBM Storage Protect output. If the backup job fails before completion, some output may indicate files backed up but not counted. This value always increases.
FILESEXPIRED
Specifies the number of files that expired during this expire job. This value remains 0 until phase expiring is reached, and then it increases until dsmc finishes. This value increases while dsmc expire jobs are running and is calculated by IBM Storage Protect output. If the backup job fails before completion, some output may indicate files expired but not counted. This value always increases.
ERRORS
Specifies the number of errors, not warnings or informational messages, which occurred during processing.
TIME
Specifies the time stamp as a ctime or number of seconds since the Epoch.
Start of change$TOTALSIZEEnd of change
Start of changeSpecifies the data in bytes to be backed up. This information is available only when MMBACKUP_PROGRESS_CONTENT environment variable contains 0x08.End of change
Start of change$SIZEBACKEDUPEnd of change
Start of changeSpecifies the data in bytes that have been backed up so far. This information is available only when MMBACKUP_PROGRESS_CONTENT environment variable contains 0x08.End of change
End of change